include/usbg/usbg.h

Go to the documentation of this file.

/*
 * Copyright (C) 2013 Linaro Limited
 *
 * Matt Porter <mporter@linaro.org>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 */

#include <dirent.h>
#include <sys/queue.h>
#include <netinet/ether.h>

#define DEFAULT_UDC             NULL
#define LANG_US_ENG             0x0409

struct state
{
        char path[256];

        TAILQ_HEAD(ghead, gadget) gadgets;
};

struct gadget
{
        char name[40];
        char path[256];
        char udc[256];
        int dclass;
        int dsubclass;
        int dproto;
        int maxpacket;
        int bcddevice;
        int bcdusb;
        int product;
        int vendor;
        char str_ser[256];
        char str_mnf[256];
        char str_prd[256];
        TAILQ_ENTRY(gadget) gnode;
        TAILQ_HEAD(chead, config) configs;
        TAILQ_HEAD(fhead, function) functions;
        struct state *parent;
};

struct config
{
        TAILQ_ENTRY(config) cnode;
        TAILQ_HEAD(bhead, binding) bindings;
        struct gadget *parent;

        char name[40];
        char path[256];
        int maxpower;
        int bmattrs;
        char str_cfg[256];
};

enum function_type
{
        F_SERIAL,
        F_ACM,
        F_OBEX,
        F_ECM,
        F_SUBSET,
        F_NCM,
        F_EEM,
        F_RNDIS,
        F_PHONET,
};

const char *function_names[] =
{
        "gser",
        "acm",
        "obex",
        "ecm",
        "geth",
        "ncm",
        "eem",
        "rndis",
        "phonet",
};

struct serial_attrs {
        int port_num;
};

struct net_attrs {
        struct ether_addr dev_addr;
        struct ether_addr host_addr;
        char ifname[256];
        int qmult;
};

struct phonet_attrs {
        char ifname[256];
};

union attrs {
        struct serial_attrs serial;
        struct net_attrs net;
        struct phonet_attrs phonet;
};

struct function
{
        TAILQ_ENTRY(function) fnode;
        struct gadget *parent;

        char name[40];
        char path[256];

        enum function_type type;
        union attrs attr;
};


struct binding
{
        TAILQ_ENTRY(binding) bnode;
        struct config *parent;
        struct function *target;

        char name[40];
        char path[256];
};

/* Library init and cleanup */

extern struct state *usbg_init(char *configfs_path);

extern void usbg_cleanup(struct state *s);

/* USB gadget queries */

extern struct gadget *usbg_get_gadget(struct state *s, const char *name);

extern struct function *usbg_get_function(struct gadget *g, const char *name);

extern struct config *usbg_get_config(struct gadget *g, const char *name);

/* USB gadget allocation and configuration */

extern struct gadget *usbg_create_gadget(struct state *s, char *name, int vendor, int product);

extern void usbg_set_gadget_device_class(struct gadget *g, int dclass);

extern void usbg_set_gadget_device_protocol(struct gadget *g, int dproto);

extern void usbg_set_gadget_device_subclass(struct gadget *g, int dsubclass);

extern void usbg_set_gadget_device_max_packet(struct gadget *g, int maxpacket);

extern void usbg_set_gadget_device_bcd_device(struct gadget *g, int bcddevice);

extern void usbg_set_gadget_device_bcd_usb(struct gadget *g, int bcdusb);

extern void usbg_set_gadget_serial_number(struct gadget *g, int lang, char *ser);

extern void usbg_set_gadget_manufacturer(struct gadget *g, int lang, char *mnf);

extern void usbg_set_gadget_product(struct gadget *g, int lang, char *prd);

/* USB function allocation and configuration */

extern struct function *usbg_create_function(struct gadget *g, enum function_type type, char *instance);

/* USB configurations allocation and configuration */

extern struct config *usbg_create_config(struct gadget *g, char *name);

extern void usbg_set_config_max_power(struct config *c, int maxpower);

extern void usbg_set_config_bm_attrs(struct config *c, int bmattrs);

extern void usbg_set_config_string(struct config *c, int lang, char *string);

extern int usbg_add_config_function(struct config *c, char *name, struct function *f);

/* USB gadget setup and teardown */

extern int usbg_get_udcs(struct dirent ***udc_list);

extern void usbg_enable_gadget(struct gadget *g, char *udc);

extern void usbg_disable_gadget(struct gadget *g);

/*
 * USB function-specific attribute configuration
 */

extern void usbg_set_net_dev_addr(struct function *f, struct ether_addr *addr);

extern void usbg_set_net_host_addr(struct function *f, struct ether_addr *addr);

extern void usbg_set_net_qmult(struct function *f, int qmult);

#define usbg_for_each_gadget(g, s)      TAILQ_FOREACH(g, &s->gadgets, gnode)

#define usbg_for_each_function(f, g)    TAILQ_FOREACH(f, &g->functions, fnode)

#define usbg_for_each_config(c, g)      TAILQ_FOREACH(c, &g->configs, cnode)

#define usbg_for_each_binding(b, c)     TAILQ_FOREACH(b, &c->bindings, bnode)