26#include <netinet/ether.h>
33#include "usbg_version.h"
50#define DEFAULT_UDC NULL
51#define LANG_US_ENG 0x0409
52#define DEFAULT_CONFIG_LABEL "config"
54#define GUID_BIN_LENGTH 16
55#define GUID_CHAR_LENGTH 36
58#define USBG_MAX_STR_LENGTH 256
59#define USBG_MAX_NAME_LENGTH 40
61#define USBG_MAX_DEV_LENGTH (USBG_MAX_NAME_LENGTH - 4)
63#define USBG_TO_UNION(UNAME, FIELD, WHAT) \
64 ((union UNAME){ .FIELD = WHAT, })
71#define USBG_RM_RECURSE 1
119 USBG_GADGET_ATTR_MIN = 0,
120 USBG_BCD_USB = USBG_GADGET_ATTR_MIN,
122 USBG_B_DEVICE_SUB_CLASS,
123 USBG_B_DEVICE_PROTOCOL,
124 USBG_B_MAX_PACKET_SIZE_0,
128 USBG_GADGET_ATTR_MAX,
137 uint8_t bDeviceClass;
138 uint8_t bDeviceSubClass;
139 uint8_t bDeviceProtocol;
140 uint8_t bMaxPacketSize0;
147 USBG_GADGET_STR_MIN = 0,
148 USBG_STR_MANUFACTURER = USBG_GADGET_STR_MIN,
150 USBG_STR_SERIAL_NUMBER,
170 uint8_t b_vendor_code;
179 USBG_GADGET_OS_DESC_MIN = 0,
180 OS_DESC_USE = USBG_GADGET_OS_DESC_MIN,
181 OS_DESC_B_VENDOR_CODE,
183 USBG_GADGET_OS_DESC_MAX,
191 uint8_t bmAttributes;
209 USBG_FUNCTION_TYPE_MIN = 0,
210 USBG_F_SERIAL = USBG_FUNCTION_TYPE_MIN,
228 USBG_FUNCTION_TYPE_MAX,
237 char *sub_compatible_id;
248 USBG_ERROR_NO_MEM = -1,
249 USBG_ERROR_NO_ACCESS = -2,
250 USBG_ERROR_INVALID_PARAM = -3,
251 USBG_ERROR_NOT_FOUND = -4,
253 USBG_ERROR_EXIST = -6,
254 USBG_ERROR_NO_DEV = -7,
255 USBG_ERROR_BUSY = -8,
256 USBG_ERROR_NOT_SUPPORTED = -9,
257 USBG_ERROR_PATH_TOO_LONG = -10,
258 USBG_ERROR_INVALID_FORMAT = -11,
259 USBG_ERROR_MISSING_TAG = -12,
260 USBG_ERROR_INVALID_TYPE = -13,
261 USBG_ERROR_INVALID_VALUE = -14,
262 USBG_ERROR_NOT_EMPTY = -15,
263 USBG_ERROR_OTHER_ERROR = -99
422 uint16_t idVendor, uint16_t idProduct,
usbg_gadget **g);
560 uint8_t bDeviceClass);
569 uint8_t bDeviceProtocol);
578 uint8_t bDeviceSubClass);
587 uint8_t bMaxPacketSize0);
635 free(g_strs->manufacturer);
636 free(g_strs->product);
637 free(g_strs->serial);
706static inline void usbg_free_gadget_os_desc(
712 free(g_os_desc->qw_sign);
830static inline void usbg_free_interf_os_desc(
836 free(f_os_desc->compatible_id);
837 free(f_os_desc->sub_compatible_id);
959 free(c_strs->configuration);
1091#define usbg_for_each_gadget(g, s) \
1092 for (g = usbg_get_first_gadget(s); \
1094 g = usbg_get_next_gadget(g))
1100#define usbg_for_each_function(f, g) \
1101 for (f = usbg_get_first_function(g); \
1103 f = usbg_get_next_function(f))
1109#define usbg_for_each_config(c, g) \
1110 for (c = usbg_get_first_config(g); \
1112 c = usbg_get_next_config(c))
1118#define usbg_for_each_binding(b, c) \
1119 for (b = usbg_get_first_binding(c); \
1121 b = usbg_get_next_binding(b))
1127#define usbg_for_each_udc(u, s) \
1128 for (u = usbg_get_first_udc(s); \
1130 u = usbg_get_next_udc(u))
const char * usbg_get_binding_name(usbg_binding *b)
Get binding name.
Definition usbg.c:2446
int usbg_get_config_strs(usbg_config *c, int lang, struct usbg_config_strs *c_strs)
Get the USB configuration strings.
Definition usbg.c:2329
int usbg_create_gadget(usbg_state *s, const char *name, const struct usbg_gadget_attrs *g_attrs, const struct usbg_gadget_strs *g_strs, usbg_gadget **g)
Create a new USB gadget device and set given attributes and strings.
Definition usbg.c:1532
usbg_function_type
Supported USB function types.
Definition usbg.h:208
int usbg_set_gadget_device_max_packet(usbg_gadget *g, uint8_t bMaxPacketSize0)
Set the maximum packet size for a gadget.
Definition usbg.c:1781
usbg_function * usbg_get_function(usbg_gadget *g, usbg_function_type type, const char *instance)
Get a function by name.
Definition usbg.c:1165
int usbg_get_config_strs_langs(usbg_config *c, int **langs)
Get the array of languages available in this config.
Definition usbg.c:1863
usbg_config * usbg_get_config(usbg_gadget *g, int id, const char *label)
Get a configuration by name.
Definition usbg.c:1177
int usbg_create_gadget_vid_pid(usbg_state *s, const char *name, uint16_t idVendor, uint16_t idProduct, usbg_gadget **g)
Create a new USB gadget device.
Definition usbg.c:1493
int usbg_rm_gadget_strs(usbg_gadget *g, int lang)
Remove gadget strings for given language.
Definition usbg.c:1423
const char * usbg_get_config_label(usbg_config *c)
Get config label.
Definition usbg.c:2257
const char * usbg_strerror(usbg_error e)
Get the short description of error.
Definition usbg_error.c:123
usbg_function * usbg_get_binding_target(usbg_binding *b)
Get target function of given binding.
Definition usbg.c:2441
int usbg_set_gadget_product(usbg_gadget *g, int lang, const char *prd)
Set the product name for a gadget.
Definition usbg.c:1985
const char * usbg_get_udc_name(usbg_udc *u)
Get name of udc.
Definition usbg.c:1598
int usbg_set_gadget_serial_number(usbg_gadget *g, int lang, const char *ser)
Set the serial number for a gadget.
Definition usbg.c:1937
const char * usbg_get_config_import_error_text(usbg_gadget *g)
Get text of error which occurred during last config import.
Definition usbg_schemes_libconfig.c:1865
int usbg_lookup_function_type(const char *name)
Lookup function type suitable for given name.
Definition usbg.c:118
int usbg_set_gadget_manufacturer(usbg_gadget *g, int lang, const char *mnf)
Set the manufacturer name for a gadget.
Definition usbg.c:1961
int usbg_rm_gadget(usbg_gadget *g, int opts)
Remove existing USB gadget.
Definition usbg.c:1350
int usbg_set_function_attrs(usbg_function *f, void *f_attrs)
Set attributes of given function.
Definition usbg.c:2615
int usbg_get_config_label_s(usbg_config *c, char *buf, int len)
Get config label into user buffer.
Definition usbg.c:2262
int usbg_import_function(usbg_gadget *g, FILE *stream, const char *instance, usbg_function **f)
Imports usb function from file and adds it to given gadget.
Definition usbg_schemes_libconfig.c:1717
int usbg_export_gadget(usbg_gadget *g, FILE *stream)
Exports whole gadget to file.
Definition usbg_schemes_libconfig.c:776
usbg_gadget * usbg_get_gadget(usbg_state *s, const char *name)
Get a gadget device by name.
Definition usbg.c:1154
int usbg_rm_config_strs(usbg_config *c, int lang)
Remove configuration strings for given language.
Definition usbg.c:1404
int usbg_set_gadget_strs(usbg_gadget *g, int lang, const struct usbg_gadget_strs *g_strs)
Set the USB gadget strings.
Definition usbg.c:1900
int usbg_rm_function(usbg_function *f, int opts)
Remove existing USB function.
Definition usbg.c:1301
int usbg_set_gadget_device_protocol(usbg_gadget *g, uint8_t bDeviceProtocol)
Set the USB gadget protocol code.
Definition usbg.c:1769
int usbg_lookup_gadget_attr(const char *name)
Lookup attr code based on its name.
Definition usbg.c:141
int usbg_set_config_max_power(usbg_config *c, int bMaxPower)
Set the configuration maximum power.
Definition usbg.c:2317
usbg_binding * usbg_get_first_binding(usbg_config *c)
Get first binding in binding list.
Definition usbg.c:2640
usbg_function * usbg_get_first_function(usbg_gadget *g)
Get first function in function list.
Definition usbg.c:2630
usbg_function * usbg_get_next_function(usbg_function *f)
Get the next function on a list.
Definition usbg.c:2655
int usbg_get_gadget_attrs(usbg_gadget *g, struct usbg_gadget_attrs *g_attrs)
Get the USB gadget strings.
Definition usbg.c:1578
int usbg_add_config_function(usbg_config *c, const char *name, usbg_function *f)
Add a function to a configuration.
Definition usbg.c:2368
int usbg_set_config_strs(usbg_config *c, int lang, const struct usbg_config_strs *c_strs)
Set the USB configuration strings.
Definition usbg.c:2336
int usbg_set_gadget_vendor_id(usbg_gadget *g, uint16_t idVendor)
Set the USB gadget vendor id.
Definition usbg.c:1751
const char * usbg_get_func_import_error_text(usbg_gadget *g)
Get text of error which occurred during last function import.
Definition usbg_schemes_libconfig.c:1849
usbg_gadget * usbg_get_next_gadget(usbg_gadget *g)
Get the next gadget on a list.
Definition usbg.c:2650
usbg_error
Errors which could be returned by library functions.
Definition usbg.h:246
int usbg_set_gadget_attr(usbg_gadget *g, usbg_gadget_attr attr, int val)
Set selected attribute to value.
Definition usbg.c:1612
int usbg_set_interf_os_desc(usbg_function *f, const char *iname, const struct usbg_function_os_desc *f_os_desc)
Set OS Descriptor compatibility of given function.
Definition usbg.c:2150
usbg_udc * usbg_get_next_udc(usbg_udc *u)
Get the next udc on a list.
Definition usbg.c:2670
int usbg_set_gadget_attrs(usbg_gadget *g, const struct usbg_gadget_attrs *g_attrs)
Set the USB gadget attributes.
Definition usbg.c:1703
int usbg_import_gadget(usbg_state *s, FILE *stream, const char *name, usbg_gadget **g)
Imports usb gadget from file.
Definition usbg_schemes_libconfig.c:1805
usbg_gadget * usbg_get_first_gadget(usbg_state *s)
Get first gadget in gadget list.
Definition usbg.c:2625
int usbg_get_config_id(usbg_config *c)
Get config id.
Definition usbg.c:2271
int usbg_set_gadget_device_bcd_device(usbg_gadget *g, uint16_t bcdDevice)
Set the gadget device BCD release number.
Definition usbg.c:1787
const char * usbg_get_configfs_path(usbg_state *s)
Get ConfigFS path.
Definition usbg.c:1141
usbg_udc * usbg_get_first_udc(usbg_state *s)
Get first udc in udc list.
Definition usbg.c:2645
usbg_gadget_os_desc_strs
Microsoft OS Descriptors strings.
Definition usbg.h:178
int usbg_get_udc_name_s(usbg_udc *u, char *buf, int len)
Get udc name into user buffer.
Definition usbg.c:1603
int usbg_export_config(usbg_config *c, FILE *stream)
Exports configuration to file.
Definition usbg_schemes_libconfig.c:749
usbg_function_type usbg_get_function_type(usbg_function *f)
Get type of given function.
Definition usbg.c:2598
usbg_config * usbg_get_first_config(usbg_gadget *g)
Get first config in config list.
Definition usbg.c:2635
int usbg_get_configfs_path_s(usbg_state *s, char *buf, int len)
Get ConfigFS path into user buffer.
Definition usbg.c:1146
int usbg_set_gadget_device_class(usbg_gadget *g, uint8_t bDeviceClass)
Set the USB gadget device class code.
Definition usbg.c:1763
int usbg_get_interf_os_desc(usbg_function *f, const char *iname, struct usbg_function_os_desc *f_os_desc)
Get OS Descriptor compatibility of given function.
Definition usbg.c:2115
int usbg_get_function_instance_s(usbg_function *f, char *buf, int len)
Get function instance name into user buffer.
Definition usbg.c:2281
int usbg_create_config(usbg_gadget *g, int id, const char *label, const struct usbg_config_attrs *c_attrs, const struct usbg_config_strs *c_strs, usbg_config **c)
Create a new USB gadget configuration.
Definition usbg.c:2179
int usbg_enable_gadget(usbg_gadget *g, usbg_udc *udc)
Enable a USB gadget device.
Definition usbg.c:2548
int usbg_rm_config(usbg_config *c, int opts)
Remove configuration.
Definition usbg.c:1247
usbg_config * usbg_get_os_desc_binding(usbg_gadget *g)
Get configuration selected for OS Descriptors.
Definition usbg.c:1242
int usbg_set_config_attrs(usbg_config *c, const struct usbg_config_attrs *c_attrs)
Set the USB configuration attributes.
Definition usbg.c:2289
int usbg_lookup_gadget_str(const char *name)
Lookup str code based on its name.
Definition usbg.c:157
int usbg_get_gadget_os_descs(usbg_gadget *g, struct usbg_gadget_os_descs *g_os_descs)
Get the USB gadget OS Descriptor.
Definition usbg.c:2009
const char * usbg_get_gadget_os_desc_name(usbg_gadget_os_desc_strs str)
Get name of selected OS Descriptor string.
Definition usbg.c:187
int usbg_import_config(usbg_gadget *g, FILE *stream, int id, usbg_config **c)
Imports usb configuration from file and adds it to given gadget.
Definition usbg_schemes_libconfig.c:1762
int usbg_init(const char *configfs_path, usbg_state **state)
Initialize the libusbgx library state.
Definition usbg.c:1091
usbg_udc * usbg_get_gadget_udc(usbg_gadget *g)
Get udc to which gadget is bound.
Definition usbg.c:1648
int usbg_get_gadget_name_s(usbg_gadget *g, char *buf, int len)
Get gadget name into user buffer.
Definition usbg.c:1590
const char * usbg_get_gadget_name(usbg_gadget *g)
Get gadget name.
Definition usbg.c:1585
const char * usbg_get_gadget_attr_str(usbg_gadget_attr attr)
Get string representing selected gadget attribute.
Definition usbg.c:173
int usbg_export_function(usbg_function *f, FILE *stream)
Exports usb function to file.
Definition usbg_schemes_libconfig.c:722
const char * usbg_get_function_instance(usbg_function *f)
Get function instance name.
Definition usbg.c:2276
int usbg_rm_binding(usbg_binding *b)
Remove binding between configuration and function.
Definition usbg.c:1221
int usbg_set_config_string(usbg_config *c, int lang, const char *string)
Set the configuration string.
Definition usbg.c:2342
void usbg_cleanup(usbg_state *s)
Clean up the libusbgx library state.
Definition usbg.c:1136
usbg_udc * usbg_get_udc(usbg_state *s, const char *name)
Get a udc by name.
Definition usbg.c:1188
int usbg_get_func_import_error_line(usbg_gadget *g)
Get line number where function import error occurred.
Definition usbg_schemes_libconfig.c:1857
usbg_gadget * usbg_get_udc_gadget(usbg_udc *u)
Get gadget which is attached to this UDC.
Definition usbg.c:1678
int usbg_set_gadget_str(usbg_gadget *g, usbg_gadget_str str, int lang, const char *val)
Set selected string.
Definition usbg.c:1868
int usbg_get_gadget_import_error_line(usbg_state *s)
Get line number where gadget import error occurred.
Definition usbg_schemes_libconfig.c:1889
int usbg_disable_gadget(usbg_gadget *g)
Disable a USB gadget device.
Definition usbg.c:2576
int usbg_set_config_bm_attrs(usbg_config *c, int bmAttributes)
Set the configuration bitmap attributes.
Definition usbg.c:2323
int usbg_create_function(usbg_gadget *g, usbg_function_type type, const char *instance, void *f_attrs, usbg_function **f)
Create a new USB gadget function and set its attributes.
Definition usbg.c:2051
int usbg_set_os_desc_config(usbg_gadget *g, usbg_config *c)
Set configuration for OS Descriptors.
Definition usbg.c:2527
void usbg_cleanup_function_attrs(usbg_function *f, void *f_attrs)
Cleanup content of function attributes.
Definition usbg.c:2609
usbg_binding * usbg_get_next_binding(usbg_binding *b)
Get the next binding on a list.
Definition usbg.c:2665
const char * usbg_get_function_type_str(usbg_function_type type)
Get function type as a string.
Definition usbg.c:134
int usbg_get_config_attrs(usbg_config *c, struct usbg_config_attrs *c_attrs)
Get the USB configuration strings.
Definition usbg.c:2310
usbg_gadget_attr
Gadget attributes which can be set using usbg_set_gadget_attr() function.
Definition usbg.h:118
int usbg_get_config_import_error_line(usbg_gadget *g)
Get line number where config import error occurred.
Definition usbg_schemes_libconfig.c:1873
const char * usbg_get_gadget_import_error_text(usbg_state *s)
Get text of error which occurred during last gadget import.
Definition usbg_schemes_libconfig.c:1881
int usbg_get_gadget_attr(usbg_gadget *g, usbg_gadget_attr attr)
Get value of selected attribute.
Definition usbg.c:1630
int usbg_get_function_attrs(usbg_function *f, void *f_attrs)
Get attributes of given function.
Definition usbg.c:2603
int usbg_get_gadget_strs_langs(usbg_gadget *g, int **langs)
Get the array of languages available in this gadget.
Definition usbg.c:1858
int usbg_set_gadget_product_id(usbg_gadget *g, uint16_t idProduct)
Set the USB gadget product id.
Definition usbg.c:1757
int usbg_set_gadget_os_descs(usbg_gadget *g, const struct usbg_gadget_os_descs *g_os_descs)
Set the USB gadget OS Descriptor.
Definition usbg.c:2016
const char * usbg_error_name(usbg_error e)
Get the error name as a constant string.
Definition usbg_error.c:62
int usbg_get_gadget_strs(usbg_gadget *g, int lang, struct usbg_gadget_strs *g_strs)
Get the USB gadget strings.
Definition usbg.c:1799
int usbg_set_gadget_device_bcd_usb(usbg_gadget *g, uint16_t bcdUSB)
Set the gadget device BCD USB version.
Definition usbg.c:1793
const char * usbg_get_gadget_str_name(usbg_gadget_str str)
Get name of selected gadget string.
Definition usbg.c:180
usbg_config * usbg_get_next_config(usbg_config *c)
Get the next config on a list.
Definition usbg.c:2660
int usbg_get_binding_name_s(usbg_binding *b, char *buf, int len)
Get binding name into user buffer.
Definition usbg.c:2451
int usbg_set_gadget_device_subclass(usbg_gadget *g, uint8_t bDeviceSubClass)
Set the USB gadget device subclass code.
Definition usbg.c:1775
USB configuration attributes.
Definition usbg.h:190
USB configuration strings.
Definition usbg.h:199
USB OS Descriptor function attributes.
Definition usbg.h:235
USB gadget device attributes.
Definition usbg.h:135
USB gadget Microsoft OS Descriptors.
Definition usbg.h:168
USB gadget device strings.
Definition usbg.h:158
Definition usbg_internal.h:143
Definition usbg_internal.h:117
Definition usbg_internal.h:129
Definition usbg_internal.h:103
Definition usbg_internal.h:93
Definition usbg_internal.h:153
Definition usbg_internal.h:51