Linux Manuals session 9

struct_usb_function – describes one function of a configuration Synopsis struct usb_function { const char *name; struct usb_gadget_strings **strings; struct usb_descriptor_header **fs_descriptors; struct usb_descriptor_header **hs_descriptors; struct usb_descriptor_header **ss_descriptors; struct usb_descriptor_header **ssp_descriptors; struct usb_configuration *config; struct usb_os_desc_table *os_desc_table; unsigned os_desc_n; int (*bind)(struct usb_configuration *, struct usb_function *); void (*unbind)(struct usb_configuration *, struct usb_function *); void (*free_func)(struct usb_function…

struct_usb_ep_caps – endpoint capabilities description Synopsis struct usb_ep_caps { unsigned type_control : 1; unsigned type_iso : 1; unsigned type_bulk : 1; unsigned type_int : 1; unsigned dir_in : 1; unsigned dir_out : 1; }; Members type_control Endpoint supports control type (reserved for ep0). type_iso Endpoint supports isochronous transfers. type_bulk Endpoint supports bulk transfers. type_int Endpoint…

struct_usb_ep – device side representation of USB endpoint Synopsis struct usb_ep { void *driver_data; const char *name; const struct usb_ep_ops *ops; struct list_head ep_list; struct usb_ep_caps caps; unsigned maxpacket : 16; unsigned maxpacket_limit : 16; unsigned max_streams : 16; unsigned mult : 2; unsigned maxburst : 5; u8 address; const struct usb_endpoint_descriptor *desc; const struct…

struct_usb_driver – identifies USB interface driver to usbcore Synopsis struct usb_driver { const char *name; int (*probe)(struct usb_interface *intf, const struct usb_device_id *id); void (*disconnect)(struct usb_interface *intf); int (*unlocked_ioctl)(struct usb_interface *intf, unsigned int code, void *buf); int (*suspend)(struct usb_interface *intf, pm_message_t message); int (*resume)(struct usb_interface *intf); int (*reset_resume)(struct usb_interface *intf); int (*pre_reset)(struct usb_interface *intf); int…

struct_usb_device_driver – identifies USB device driver to usbcore Synopsis struct usb_device_driver { const char *name; int (*probe)(struct usb_device *udev); void (*disconnect)(struct usb_device *udev); int (*suspend)(struct usb_device *udev, pm_message_t message); int (*resume)(struct usb_device *udev, pm_message_t message); struct usbdrv_wrap drvwrap; unsigned int supports_autosuspend : 1; }; Members name The driver name should be unique among USB drivers,…

struct_usb_device – kernel’s representation of a USB device Synopsis struct usb_device { int devnum; char devpath[16]; u32 route; enum usb_device_state state; enum usb_device_speed speed; struct usb_tt *tt; int ttport; unsigned int toggle[2]; struct usb_device *parent; struct usb_bus *bus; struct usb_host_endpoint ep0; struct device dev; struct usb_device_descriptor descriptor; struct usb_host_bos *bos; struct usb_host_config *config; struct usb_host_config…

struct_usb_configuration – represents one gadget configuration Synopsis struct usb_configuration { const char *label; struct usb_gadget_strings **strings; const struct usb_descriptor_header **descriptors; void (*unbind)(struct usb_configuration *); int (*setup)(struct usb_configuration *, const struct usb_ctrlrequest *); u8 bConfigurationValue; u8 iConfiguration; u8 bmAttributes; u16 MaxPower; struct usb_composite_dev *cdev; }; Members label For diagnostics, describes the configuration. strings Tables of strings,…

struct_usb_composite_driver – groups configurations into a gadget Synopsis struct usb_composite_driver { const char *name; const struct usb_device_descriptor *dev; struct usb_gadget_strings **strings; enum usb_device_speed max_speed; unsigned needs_serial : 1; int (*bind)(struct usb_composite_dev *cdev); int (*unbind)(struct usb_composite_dev *); void (*disconnect)(struct usb_composite_dev *); void (*suspend)(struct usb_composite_dev *); void (*resume)(struct usb_composite_dev *); struct usb_gadget_driver gadget_driver; }; Members name For…

struct_usb_composite_dev – represents one composite usb gadget Synopsis struct usb_composite_dev { struct usb_gadget *gadget; struct usb_request *req; struct usb_request *os_desc_req; struct usb_configuration *config; u8 qw_sign[OS_STRING_QW_SIGN_LEN]; u8 b_vendor_code; struct usb_configuration *os_desc_config; unsigned int use_os_string : 1; }; Members gadget read-only, abstracts the gadget’s usb peripheral controller req used for control responses; buffer is pre-allocated os_desc_req used…

struct_usb_class_driver – identifies a USB driver that wants to use the USB major number Synopsis struct usb_class_driver { char *name; char *(*devnode)(struct device *dev, umode_t *mode); const struct file_operations *fops; int minor_base; }; Members name the usb class device name for this driver. Will show up in sysfs. devnode Callback to provide a naming hint…

struct_urb – USB Request Block Synopsis struct urb { struct list_head urb_list; struct list_head anchor_list; struct usb_anchor *anchor; struct usb_device *dev; struct usb_host_endpoint *ep; unsigned int pipe; unsigned int stream_id; int status; unsigned int transfer_flags; void *transfer_buffer; dma_addr_t transfer_dma; struct scatterlist *sg; int num_mapped_sgs; int num_sgs; u32 transfer_buffer_length; u32 actual_length; unsigned char *setup_packet; dma_addr_t setup_dma;…

struct_sublog – subchannel logout area Synopsis struct sublog { __u32 res0 : 1; __u32 esf : 7; __u32 lpum : 8; __u32 arep : 1; __u32 fvf : 5; __u32 sacc : 2; __u32 termc : 2; __u32 devsc : 1; __u32 serr : 1; __u32 ioerr : 1; __u32 seqc : 3; }; Members…

struct_socket – general BSD socket Synopsis struct socket { socket_state state; short type; unsigned long flags; struct socket_wq __rcu *wq; struct file *file; struct sock *sk; const struct proto_ops *ops; }; Members state socket state (SS_CONNECTED, etc) type socket type (SOCK_STREAM, etc) flags socket flags (SOCK_NOSPACE, etc) wq wait queue for several uses file File…

struct_sock_common – minimal network layer representation of sockets Synopsis struct sock_common { union { unnamed_union }; }; Members {unnamed_union} anonymous Description This is the minimal network layer representation of sockets, the header for struct sock and struct inet_timewait_sock. Copyright

struct_sock – network layer representation of sockets Synopsis struct sock { struct sock_common __sk_common; #define sk_node __sk_common.skc_node #define sk_nulls_node __sk_common.skc_nulls_node #define sk_refcnt __sk_common.skc_refcnt #define sk_tx_queue_mapping __sk_common.skc_tx_queue_mapping #define sk_dontcopy_begin __sk_common.skc_dontcopy_begin #define sk_dontcopy_end __sk_common.skc_dontcopy_end #define sk_hash __sk_common.skc_hash #define sk_portpair __sk_common.skc_portpair #define sk_num __sk_common.skc_num #define sk_dport __sk_common.skc_dport #define sk_addrpair __sk_common.skc_addrpair #define sk_daddr __sk_common.skc_daddr #define sk_rcv_saddr __sk_common.skc_rcv_saddr #define sk_family…

struct_snd_soc_jack_zone – Describes voltage zones of jack detection Synopsis struct snd_soc_jack_zone { unsigned int min_mv; unsigned int max_mv; unsigned int jack_type; unsigned int debounce_time; struct list_head list; }; Members min_mv start voltage in mv max_mv end voltage in mv jack_type type of jack that is expected for this voltage debounce_time debounce_time for jack, codec driver…

struct_snd_soc_jack_pin – Describes a pin to update based on jack detection Synopsis struct snd_soc_jack_pin { struct list_head list; const char *pin; int mask; bool invert; }; Members list internal list entry pin name of the pin to update mask bits to check for in reported jack status invert if non-zero then pin is enabled when…

struct_snd_soc_jack_gpio – Describes a gpio pin for jack detection Synopsis struct snd_soc_jack_gpio { unsigned int gpio; unsigned int idx; struct device *gpiod_dev; const char *name; int report; int invert; int debounce_time; bool wake; int (*jack_status_check)(void *data); }; Members gpio legacy gpio number idx gpio descriptor index within the function of the GPIO consumer device gpiod_dev…

struct_snd_enc_vorbis – Synopsis struct snd_enc_vorbis { __s32 quality; __u32 managed; __u32 max_bit_rate; __u32 min_bit_rate; __u32 downmix; }; Members quality Sets encoding quality to n, between -1 (low) and 10 (high). In the default mode of operation, the quality level is 3. Normal quality range is 0 – 10. managed Boolean. Set bitrate management mode. This…

struct_snd_enc_real – Synopsis struct snd_enc_real { __u32 quant_bits; __u32 start_region; __u32 num_regions; }; Members quant_bits number of coupling quantization bits in the stream start_region coupling start region in the stream num_regions number of regions value Description These options were extracted from the OpenMAX IL spec Copyright