chardev/char-i2c: Implement Linux I2C character device
PATCH v2 1/1 chardev/char-i2c: Implement Linux I2C character device
Add support for Linux I2C character device for I2C device passthrough For example:
-chardev linux-i2c,address=0x46,path=/dev/i2c-N,id=i2c-chardev
---
v2:
* Fix errors
* update "MAINTAINERS" file.
--- MAINTAINERS | 6 ++ chardev/Makefile.objs | 1 + chardev/char-i2c.c | 140 +++++++++++++++++++++++++++++++++++++++++++++ chardev/char.c | 3 + include/chardev/char-i2c.h | 35 ++++++++++++ include/chardev/char.h | 1 + qapi/char.json | 18 ++++++ 7 files changed, 204 insertions(+) create mode 100644 chardev/char-i2c.c create mode 100644 include/chardev/char-i2c.h
MAINTAINERS +6 -0
@@ -1801,6 +1801,12 @@ M: Samuel Thibault <[email protected]> S: Maintained F: chardev/baum.c +Character Devices (Linux I2C) +M: Ernest Esene <[email protected]> +S: Maintained +F: chardev/char-i2c.c +F: include/chardev/char-i2c.h + Command line option argument parsing M: Markus Armbruster <[email protected]> S: Supported
chardev/Makefile.objs +1 -0
@@ -16,6 +16,7 @@ chardev-obj-y += char-stdio.o chardev-obj-y += char-udp.o chardev-obj-$(CONFIG_WIN32) += char-win.o chardev-obj-$(CONFIG_WIN32) += char-win-stdio.o +chardev-obj-$(CONFIG_POSIX) +=char-i2c.o common-obj-y += msmouse.o wctablet.o testdev.o common-obj-$(CONFIG_BRLAPI) += baum.o
chardev/char-i2c.c new file +140 -0
140 lines not on this page · raw message
chardev/char.c +3 -0
@@ -926,6 +926,9 @@ QemuOptsList qemu_chardev_opts = { },{ .name = "logappend", .type = QEMU_OPT_BOOL, + },{ + .name = "address", + .type = QEMU_OPT_STRING, }, {/* end of list */ } },
include/chardev/char-i2c.h new file +35 -0
@@ -0,0 +1,35 @@ + +/* +* QEMU System Emulator +* +* Copyright (c) 2019 Ernest Esene <[email protected]> +* +* Permission is hereby granted, free of charge, to any person obtaining a copy +* of this software and associated documentation files (the "Software"), to deal +* in the Software without restriction, including without limitation the rights +* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +* copies of the Software, and to permit persons to whom the Software is +* furnished to do so, subject to the following conditions: +* +* The above copyright notice and this permission notice shall be included in +* all copies or substantial portions of the Software. +* +* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL +* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +* THE SOFTWARE. +*/ +#ifndef CHAR_I2C_H +#define CHAR_I2C_H + +#define CHR_IOCTL_I2C_SET_ADDR 1 + +#define CHR_I2C_ADDR_10BIT_MAX 1023 +#define CHR_I2C_ADDR_7BIT_MAX 127 + +void qemu_set_block (int fd); + +#endif /* ifndef CHAR_I2C_H */
include/chardev/char.h +1 -0
@@ -245,6 +245,7 @@ int qemu_chr_wait_connected(Chardev *chr, Error **errp);#define TYPE_CHARDEV_SERIAL "chardev-serial"#define TYPE_CHARDEV_SOCKET "chardev-socket"#define TYPE_CHARDEV_UDP "chardev-udp" +#define TYPE_CHARDEV_I2C "chardev-linux-i2c"#define CHARDEV_IS_RINGBUF (chr) \ object_dynamic_cast(OBJECT(chr), TYPE_CHARDEV_RINGBUF)
qapi/char.json +18 -0
@@ -240,6 +240,23 @@ 'data': { 'device': 'str' }, 'base': 'ChardevCommon' } +## +# @ChardevI2c: +# +# Configuration info for i2c chardev. +# +# @device: The name of the special file for the device, +# i.e. /dev/i2c-0 on linux +# @address: The address of the i2c device on the host. +# +# Since: 4.1 +## +{ 'struct': 'ChardevI2c', + 'data': { 'device': 'str', + 'address': 'int16'}, + 'base': 'ChardevCommon', + 'if': 'defined(CONFIG_LINUX)'} + ## # @ChardevSocket: #
@@ -398,6 +415,7 @@ 'data': { 'file': 'ChardevFile', 'serial': 'ChardevHostdev', 'parallel': 'ChardevHostdev', + 'i2c': 'ChardevI2c', 'pipe': 'ChardevHostdev', 'socket': 'ChardevSocket', 'udp': 'ChardevUdp',
Signature · 1 line
2.14.2
Quoted 5 lines · Ernest Esene
Add support for Linux I2C character device for I2C device passthrough For example:
-chardev linux-i2c,address=0x46,path=/dev/i2c-N,id=i2c-chardevSigned-off-by Ernest Esene <[email protected]>
Could you explain briefly how passing through a host's I2C device can be useful?
Quoted 22 lines
---
v2:
* Fix errors
* update "MAINTAINERS" file.--- MAINTAINERS | 6 ++ chardev/Makefile.objs | 1 + chardev/char-i2c.c | 140 +++++++++++++++++++++++++++++++++++++++++++++ chardev/char.c | 3 + include/chardev/char-i2c.h | 35 ++++++++++++ include/chardev/char.h | 1 + qapi/char.json | 18 ++++++ 7 files changed, 204 insertions(+) create mode 100644 chardev/char-i2c.c create mode 100644 include/chardev/char-i2c.hMAINTAINERS +0
-0
MAINTAINERS M: Samuel Thibault <[email protected]> · line 1809
Quoted 9 lines
MAINTAINERS +6
-0@@ -1801,6 +1801,12 @@ M: Samuel Thibault <[email protected]> S: Maintained F: chardev/baum.c +Character Devices (Linux I2C) +M: Ernest Esene <[email protected]> +S: Maintained +F: chardev/char-i2c.c +F: include/chardev/char-i2c.h +
Thanks for backing your contribution with an offer to maintain it. Accepting the offer is up to the Character device backends maintainer Marc-André, I think.
Quoted 34 lines
MAINTAINERS +0
-0Command line option argument parsing M: Markus Armbruster <[email protected]> S: Supportedchardev/Makefile.objs +1
-0@@ -16,6 +16,7 @@ chardev-obj-y += char-stdio.o chardev-obj-y += char-udp.o chardev-obj-$(CONFIG_WIN32) += char-win.o chardev-obj-$(CONFIG_WIN32) += char-win-stdio.o +chardev-obj-$(CONFIG_POSIX) +=char-i2c.o common-obj-y += msmouse.o wctablet.o testdev.o common-obj-$(CONFIG_BRLAPI) += baum.ochardev/char-i2c.c new file +13
-0@@ -0,0 +1,140 @@ +/* +* QEMU System Emulator +* +* Copyright (c) 2019 Ernest Esene <[email protected]> +* +* Permission is hereby granted, free of charge, to any person obtaining a copy +* of this software and associated documentation files (the "Software"), to deal +* in the Software without restriction, including without limitation the rights +* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +* copies of the Software, and to permit persons to whom the Software is +* furnished to do so, subject to the following conditions: +* +* The above copyright notice and this permission notice shall be included in
chardev/char-i2c.c line 23
Quoted 10 lines
chardev/char-i2c.c new file +10
-0+* all copies or substantial portions of the Software. +* +* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL +* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +* THE SOFTWARE. +*/
Any particular reason not to use GPLv2+?
My knowledge of I2C rounds to zero, so I can only review for basic sanity.
Quoted 14 lines
chardev/char-i2c.c new file +14
-0+#include "qemu/osdep.h" +#include "qapi/error.h" +#include "qemu/option.h" +#include "qemu-common.h" +#include "io/channel-file.h" +#include "qemu/cutils.h" + +#include "chardev/char-fd.h" +#include "chardev/char-i2c.h" +#include "chardev/char.h" + +#include <sys/ioctl.h> +#include <linux/i2c-dev.h> +
chardev/char-i2c.c line 47
Quoted 10 lines
chardev/char-i2c.c new file +10
-0+static int i2c_ioctl (Chardev *chr,int cmd,void *arg) +{ +FDChardev *fd_chr =FD_CHARDEV (chr); +QIOChannelFile *floc =QIO_CHANNEL_FILE (fd_chr->ioc_in); +int fd = floc->fd; +int addr; + +switch (cmd) { +case CHR_IOCTL_I2C_SET_ADDR : + addr = (int ) (long ) arg;
Would (int)arg make the compiler unhappy?
chardev/char-i2c.c line 53
Quoted 6 lines
chardev/char-i2c.c new file +6
-0+ +if (addr >CHR_I2C_ADDR_7BIT_MAX ) { +/* +* TODO: check if adapter support 10-bit addr +* I2C_FUNC_10BIT_ADDR +*/
What's the impact of not having done this TODO?
Should it be mentioned in the commit message?
Quoted 21 lines
chardev/char-i2c.c new file +21
-0+if (ioctl (fd,I2C_TENBIT , addr) <0 ) { + goto err; + } + }else { +if (ioctl (fd,I2C_SLAVE , addr) <0 ) { + goto err; + } + } +break ; + +default : +return -ENOTSUP ; + } +return 0 ; +err: +return -ENOTSUP ; +} + +static void qmp_chardev_open_i2c (Chardev *chr,ChardevBackend *backend, +bool *be_opened,Error **errp) +{
chardev/char-i2c.c line 84
Quoted 10 lines
chardev/char-i2c.c new file +10
-0+ChardevI2c *i2c = backend->u.i2c.data; +void *addr; +int fd; + + fd =qmp_chardev_open_file_source (i2c->device,O_RDWR |O_NONBLOCK , + errp); +if (fd <0 ) { +return ; + } +qemu_set_block (fd);
Sure we want *blocking* I/O? No other character device does.
chardev/char-i2c.c line 86
Quoted 2 lines
chardev/char-i2c.c new file +2
-0+qemu_chr_open_fd (chr, fd, fd); + addr = (void *) (long ) i2c->address;
Would (void *)i2c->address make the compiler unhappy?
chardev/char-i2c.c line 96
Quoted 10 lines
chardev/char-i2c.c new file +10
-0+i2c_ioctl (chr,CHR_IOCTL_I2C_SET_ADDR , addr); +} + +static void qemu_chr_parse_i2c (QemuOpts *opts,ChardevBackend *backend, +Error **errp) +{ +const char *device =qemu_opt_get (opts,"path" ); +const char *addr =qemu_opt_get (opts,"address" ); +long address; +ChardevI2c *i2c;
Blank line between declarations and statements, please.
chardev/char-i2c.c line 108
Quoted 12 lines
chardev/char-i2c.c new file +12
-0+if (device ==NULL ) { +error_setg (errp,"chardev: linux-i2c: no device path given" ); +return ; + } +if (addr ==NULL ) { +error_setg (errp,"chardev: linux-i2c: no device address given" ); +return ; + } +if (qemu_strtol (addr,NULL ,0 , &address) !=0 ) { +error_setg (errp,"chardev: linux-i2c: invalid device address given" ); +return ; + }
Why not make option "addr" QEMU_OPT_NUMBER and use qemu_opt_get_number()?
chardev/char-i2c.c line 117
Quoted 9 lines
chardev/char-i2c.c new file +9
-0+if (address <0 || address >CHR_I2C_ADDR_10BIT_MAX ) { +error_setg (errp,"chardev: linux-i2c: device address out of range" ); +return ; + } + backend->type =CHARDEV_BACKEND_KIND_I2C ; + i2c = backend->u.i2c.data =g_new0 (ChardevI2c,1 ); +qemu_chr_parse_common (opts,qapi_ChardevI2c_base (i2c)); + i2c->device =g_strdup (device); + i2c->address = (int16_t ) address;
No space between (int16_t) and address, please. Same for other type casts elsewhere.
Quoted 66 lines
chardev/char-i2c.c new file +23
-0+} + +static void char_i2c_class_init (ObjectClass *oc,void *data) +{ +ChardevClass *cc =CHARDEV_CLASS (oc); + + cc->parse = qemu_chr_parse_i2c; + cc->open = qmp_chardev_open_i2c; + cc->chr_ioctl = i2c_ioctl; +} + +static const TypeInfo char_i2c_type_info = { + .name =TYPE_CHARDEV_I2C , + .parent =TYPE_CHARDEV_FD , + .class_init = char_i2c_class_init, +}; + +static void register_types (void ) +{ +type_register_static (&char_i2c_type_info); +} + +type_init (register_types);chardev/char.c +3
-0@@ -926,6 +926,9 @@ QemuOptsList qemu_chardev_opts = { },{ .name = "logappend", .type = QEMU_OPT_BOOL, + },{ + .name = "address", + .type = QEMU_OPT_STRING, }, {/* end of list */ } },include/chardev/char-i2c.h new file +23
-0@@ -0,0 +1,35 @@ + +/* +* QEMU System Emulator +* +* Copyright (c) 2019 Ernest Esene <[email protected]> +* +* Permission is hereby granted, free of charge, to any person obtaining a copy +* of this software and associated documentation files (the "Software"), to deal +* in the Software without restriction, including without limitation the rights +* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +* copies of the Software, and to permit persons to whom the Software is +* furnished to do so, subject to the following conditions: +* +* The above copyright notice and this permission notice shall be included in +* all copies or substantial portions of the Software. +* +* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL +* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +* THE SOFTWARE.
include/chardev/char-i2c.h line 33
Quoted 10 lines
include/chardev/char-i2c.h new file +10
-0+*/ +#ifndef CHAR_I2C_H +#define CHAR_I2C_H + +#define CHR_IOCTL_I2C_SET_ADDR 1 + +#define CHR_I2C_ADDR_10BIT_MAX 1023 +#define CHR_I2C_ADDR_7BIT_MAX 127 + +void qemu_set_block (int fd);
Declaring qemu_set_block() again is inappropriate. Include qemu/sockets.h instead.
include/chardev/char-i2c.h line 35
Quoted 2 lines
include/chardev/char-i2c.h new file +2
-0+ +#endif /* ifndef CHAR_I2C_H */
This header is included only by chardev/char.c. Why does it exist?
Quoted 41 lines
include/chardev/char.h +1
-0@@ -245,6 +245,7 @@ int qemu_chr_wait_connected(Chardev *chr, Error **errp);#define TYPE_CHARDEV_SERIAL "chardev-serial"#define TYPE_CHARDEV_SOCKET "chardev-socket"#define TYPE_CHARDEV_UDP "chardev-udp" +#define TYPE_CHARDEV_I2C "chardev-linux-i2c"#define CHARDEV_IS_RINGBUF (chr) \ object_dynamic_cast(OBJECT(chr), TYPE_CHARDEV_RINGBUF)qapi/char.json +17
-0@@ -240,6 +240,23 @@ 'data': { 'device': 'str' }, 'base': 'ChardevCommon' } +## +# @ChardevI2c: +# +# Configuration info for i2c chardev. +# +# @device: The name of the special file for the device, +# i.e. /dev/i2c-0 on linux +# @address: The address of the i2c device on the host. +# +# Since: 4.1 +## +{ 'struct': 'ChardevI2c', + 'data': { 'device': 'str', + 'address': 'int16'}, + 'base': 'ChardevCommon', + 'if': 'defined(CONFIG_LINUX)'} + ## # @ChardevSocket: #
qapi/char.json line 421
Quoted 7 lines
qapi/char.json +1
-0@@ -398,6 +415,7 @@ 'data': { 'file': 'ChardevFile', 'serial': 'ChardevHostdev', 'parallel': 'ChardevHostdev', + 'i2c': 'ChardevI2c', 'pipe': 'ChardevHostdev', 'socket': 'ChardevSocket', 'udp': 'ChardevUdp',
Missing: documentation update for qemu-options.hx.
Quoted 4 lines · Markus Armbruster
Quoted 4 lines
chardev/char-i2c.c new file +4
-0+static int i2c_ioctl (Chardev *chr,int cmd,void *arg) +{ +FDChardev *fd_chr =FD_CHARDEV (chr); +QIOChannelFile *floc =QIO_CHANNEL_FILE (fd_chr->ioc_in);
Quoted 8 lines
chardev/char-i2c.c line 47
Quoted 6 lines
chardev/char-i2c.c new file +6
-0+int fd = floc->fd; +int addr; + +switch (cmd) { +case CHR_IOCTL_I2C_SET_ADDR : + addr = (int ) (long ) arg;Would (int)arg make the compiler unhappy?
If you're trying to pass an integer through void*, it's probably best to write:
addr = (intptr_t) arg;
Signature · 3 lines
Eric Blake, Principal Software Engineer Red Hat, Inc. +1-919-301-3226 Virtualization: qemu.org | libvirt.org
Quoted 3 lines · Ernest Esene
Add support for Linux I2C character device for I2C device passthrough For example:
-chardev linux-i2c,address=0x46,path=/dev/i2c-N,id=i2c-chardev
There is a mixture of "linux-i2c" and "char-i2c" names in this patch, which I find confusing. Maybe you changed your mind while writing this code. There are two options:
1. Call it "linux-i2c". Other host operating systems will need their own equivalent objects.
2. Call it "char-i2c" and make all the parameters optional since they are likely to work differently on other host operating systems.
I tend towards the second approach because I think I2C is simple enough that a single user-visible object can work on all host operating systems.
Please make the naming consistent in the next revision of this patch.
Quoted 7 lines
Signed-off-by Ernest Esene <[email protected]>---
v2:
* Fix errors
* update "MAINTAINERS" file.
Quoted 11 lines
--- MAINTAINERS | 6 ++ chardev/Makefile.objs | 1 + chardev/char-i2c.c | 140 +++++++++++++++++++++++++++++++++++++++++++++ chardev/char.c | 3 + include/chardev/char-i2c.h | 35 ++++++++++++ include/chardev/char.h | 1 + qapi/char.json | 18 ++++++ 7 files changed, 204 insertions(+) create mode 100644 chardev/char-i2c.c create mode 100644 include/chardev/char-i2c.h
Please update the qemu-options.texi user documentation.
Quoted 10 lines · Markus Armbruster
Quoted 5 lines · Ernest Esene
Add support for Linux I2C character device for I2C device passthrough For example:
-chardev linux-i2c,address=0x46,path=/dev/i2c-N,id=i2c-chardevSigned-off-by Ernest Esene <[email protected]>Could you explain briefly how passing through a host's I2C device can be useful?
QEMU supports emulation of I2C devices in software but currently can't passthrough to real I2C devices. This feature is needed by developers using QEMU for writing and testing software for I2C devices.
Quoted 2 lines
Any particular reason not to use GPLv2+?
No, I used the wrong script. I'll update the licence.
Quoted 8 lines
chardev/char-i2c.c line 53
Quoted 6 lines
chardev/char-i2c.c new file +6
-0+ +if (addr >CHR_I2C_ADDR_7BIT_MAX ) { +/* +* TODO: check if adapter support 10-bit addr +* I2C_FUNC_10BIT_ADDR +*/ What's the impact of not having done this TODO?
Not all I2C adapters supports 10-bit address.
Quoted 1 line
Should it be mentioned in the commit message?
I have handled it already.
Quoted 5 lines
chardev/char-i2c.c line 84
Quoted 3 lines
chardev/char-i2c.c new file +3
-0+return ; + } +qemu_set_block (fd);Sure we want *blocking* I/O? No other character device does.
No, it is a mistake.
Quoted 7 lines
chardev/char-i2c.c line 86
Quoted 3 lines
chardev/char-i2c.c new file +2
-0+qemu_chr_open_fd (chr, fd, fd); + addr = (void *) (long ) i2c->address;Why not make option "addr"
QEMU_OPT_NUMBERand useqemu_opt_get_number()?
I never knew QEMU_OPT_NUMBER can handle inputs such: "0x08 and 8", appropriately.
Quoted 2 lines
Missing: documentation update for qemu-options.hx.
I don't know much about this format (.hx), I'll be happy to have any useful documentation on this.
Thank you.
-Ernest Esene
Quoted 7 lines · Ernest Esene
Quoted 6 lines · Markus Armbruster
Quoted 4 lines · Ernest Esene
Add support for Linux I2C character device for I2C device passthrough For example:
-chardev linux-i2c,address=0x46,path=/dev/i2c-N,id=i2c-chardev
Quoted 7 lines
Quoted 4 lines
Quoted 1 line
Signed-off-by Ernest Esene <[email protected]>Could you explain briefly how passing through a host's I2C device can be useful?
QEMU supports emulation of I2C devices in software but currently can't passthrough to real I2C devices. This feature is needed by developers using QEMU for writing and testing software for I2C devices.
Please work that into your commit message. Remember, you commit message is also your patch's sales pitch.
Quoted 2 lines
Quoted 1 line
Any particular reason not to use GPLv2+?
No, I used the wrong script. I'll update the licence.
Thanks!
Quoted 11 lines
Quoted 8 lines
chardev/char-i2c.c line 53
Quoted 6 lines
chardev/char-i2c.c new file +6
-0+ +if (addr >CHR_I2C_ADDR_7BIT_MAX ) { +/* +* TODO: check if adapter support 10-bit addr +* I2C_FUNC_10BIT_ADDR +*/ What's the impact of not having done this TODO?
Not all I2C adapters supports 10-bit address.
Quoted 1 line
Should it be mentioned in the commit message?
I have handled it already.
Cool.
Quoted 11 lines
Quoted 5 lines
chardev/char-i2c.c line 84
Quoted 3 lines
chardev/char-i2c.c new file +3
-0+return ; + } +qemu_set_block (fd);Sure we want *blocking* I/O? No other character device does.
No, it is a mistake.
Quoted 5 lines
Quoted 3 lines
chardev/char-i2c.c new file +2
-0+qemu_chr_open_fd (chr, fd, fd); + addr = (void *) (long ) i2c->address;
Quoted 8 lines
Quoted 2 lines
Why not make option "addr"
QEMU_OPT_NUMBERand useqemu_opt_get_number()?I never knew
QEMU_OPT_NUMBERcan handle inputs such: "0x08and 8", appropriately.Quoted 2 lines
Missing: documentation update for qemu-options.hx.
I don't know much about this format (.hx), I'll be happy to have any useful documentation on this.
I don't think we have any documentation on it, let alone useful documentation.
Here's what you need to do there for your new chardev backend type, using your voodoo coding skills.
Find this line:
DEFHEADING(Character device options:)
This is where option -chardev is defined and documented.
Now pick an existing chardev backend. Picking one that's vaguely similar to yours is best. Let's pick "serial", because it also passes through a host device.
First occurence is this:
#ifdef _WIN32
"-chardev console,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
"-chardev serial,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
#else
"-chardev pty,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
"-chardev stdio,id=id[,mux=on|off][,signal=on|off][,logfile=PATH][,logappend=on|off]\n"
#endifYou see _WIN32, and immediately skip to the next one:
#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
|| defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
"-chardev serial,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
"-chardev tty,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
#endifUsing your vodoo coding skills, you add
#ifdef CONFIG_POSIX
"-chardev i2c,id=id,path=path,address=address[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
#endifCONFIG_POSIX, because that's what you used in Makefile.objs. Your commit message says "Linux I2C character device", so maybe you should use CONFIG_LINUX instead of CONFIG_POSIX throughout, but what do I know.
The next occurence is
The general form of a character device option is:
@table @option
@item -chardev @var{backend},id=@var{id}[,mux=on|off][,@var{options}]
@findex -chardev
Backend is one of:
@option{null},
@option{socket},
@option{udp},
@option{msmouse},
@option{vc},
@option{ringbuf},
@option{file},
@option{pipe},
@option{console},
@option{serial},So you add
@option{i2c},I think you get the idea. If not, the time-honored way to get more help is to post a patch that's not quite right ;)
Quoted 12 lines · Stefan Hajnoczi
Quoted 3 lines · Ernest Esene
Add support for Linux I2C character device for I2C device passthrough For example:
-chardev linux-i2c,address=0x46,path=/dev/i2c-N,id=i2c-chardevThere is a mixture of "linux-i2c" and "char-i2c" names in this patch, which I find confusing. Maybe you changed your mind while writing this code. There are two options:
1. Call it "linux-i2c". Other host operating systems will need their own equivalent objects.
Quoted 8 lines
2. Call it "char-i2c" and make all the parameters optional since they are likely to work differently on other host operating systems.
I tend towards the second approach because I think I2C is simple enough that a single user-visible object can work on all host operating systems.
Please make the naming consistent in the next revision of this patch.
My coding skills is limited to only Linux, I prefer the first approach as is makes it easy.