usbus.h File Reference

USBUS basic interface. More...

Detailed Description

USBUS basic interface.

Author
Koen Zandberg koen@.nosp@m.berg.nosp@m.zand..nosp@m.net

Definition in file usbus.h.

#include <stdint.h>
#include <stdlib.h>
#include "clist.h"
#include "event.h"
#include "kernel_types.h"
#include "msg.h"
#include "thread.h"
#include "usb.h"
#include "periph/usbdev.h"
#include "usb/descriptor.h"
+ Include dependency graph for usbus.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  usbus_string
 USBUS string type. More...
 
struct  usbus_hdr_gen_funcs_t
 USBUS header generator function pointers. More...
 
struct  usbus_hdr_gen
 USBUS header generator. More...
 
struct  usbus_endpoint
 USBUS endpoint context. More...
 
struct  usbus_interface_alt
 USBUS interface alternative setting. More...
 
struct  usbus_interface
 USBUS interface. More...
 
struct  usbus_handler_driver
 USBUS event handler function pointers. More...
 
struct  usbus_handler
 USBUS handler struct. More...
 
struct  usbus
 USBUS context struct. More...
 

Macros

#define USBUS_STACKSIZE   (THREAD_STACKSIZE_DEFAULT)
 USBUS thread stack size.
 
#define USBUS_PRIO   (THREAD_PRIORITY_MAIN - 6)
 USBUS thread priority.
 
#define USBUS_TNAME   "usbus"
 USBUS thread name.
 
#define USBUS_AUTO_ATTACH   (1)
 USBUS auto attach setting. More...
 
#define USBUS_EP0_SIZE   64
 USBUS endpoint 0 buffer size. More...
 

Typedefs

typedef struct usbus_string usbus_string_t
 USBUS string type.
 
typedef struct usbus usbus_t
 USBUS context forward declaration.
 
typedef struct usbus_handler usbus_handler_t
 USBUS event handler forward declaration.
 
typedef struct usbus_hdr_gen usbus_hdr_gen_t
 USBUS header generator. More...
 
typedef struct usbus_endpoint usbus_endpoint_t
 USBUS endpoint context.
 
typedef struct usbus_interface_alt usbus_interface_alt_t
 USBUS interface alternative setting. More...
 
typedef struct usbus_interface usbus_interface_t
 USBUS interface.
 
typedef struct usbus_handler_driver usbus_handler_driver_t
 USBUS event handler function pointers.
 

Enumerations

enum  usbus_event_usb_t { USBUS_EVENT_USB_RESET, USBUS_EVENT_USB_SOF, USBUS_EVENT_USB_SUSPEND, USBUS_EVENT_USB_RESUME }
 USB handler events. More...
 
enum  usbus_event_transfer_t { USBUS_EVENT_TRANSFER_COMPLETE, USBUS_EVENT_TRANSFER_FAIL, USBUS_EVENT_TRANSFER_STALL }
 USB endpoint transfer status events. More...
 
enum  usbus_state_t {
  USBUS_STATE_DISCONNECT, USBUS_STATE_RESET, USBUS_STATE_ADDR, USBUS_STATE_CONFIGURED,
  USBUS_STATE_SUSPEND
}
 state machine states for the global USBUS thread More...
 
enum  usbus_setuprq_state_t {
  USBUS_SETUPRQ_READY, USBUS_SETUPRQ_INDATA, USBUS_SETUPRQ_OUTACK, USBUS_SETUPRQ_OUTDATA,
  USBUS_SETUPRQ_INACK
}
 USBUS setup request state machine. More...
 
enum  usbus_hdr_len_type_t { USBUS_HDR_LEN_FIXED, USBUS_HDR_LEN_FUNC }
 Header length types for USB descriptor generators. More...
 

Functions

static void usbus_event_post (usbus_t *usbus, event_t *event)
 Submit an event to the usbus thread. More...
 
uint16_t usbus_add_string_descriptor (usbus_t *usbus, usbus_string_t *desc, const char *str)
 Add a string descriptor to the USBUS thread context. More...
 
uint16_t usbus_add_interface (usbus_t *usbus, usbus_interface_t *iface)
 Add an interface to the USBUS thread context. More...
 
usbus_endpoint_tusbus_add_endpoint (usbus_t *usbus, usbus_interface_t *iface, usb_ep_type_t type, usb_ep_dir_t dir, size_t len)
 Add an endpoint to the specified interface. More...
 
void usbus_add_conf_descriptor (usbus_t *usbus, usbus_hdr_gen_t *hdr_gen)
 Add a generator for generating additional top level USB descriptor content. More...
 
void usbus_register_event_handler (usbus_t *usbus, usbus_handler_t *handler)
 Add an event handler to the USBUS context. More...
 
void usbus_init (usbus_t *usbus, usbdev_t *usbdev)
 Initialize an USBUS context. More...
 
void usbus_create (char *stack, int stacksize, char priority, const char *name, usbus_t *usbus)
 Create and start the USBUS thread. More...
 
static void usbus_enable_endpoint (usbus_endpoint_t *ep)
 Enable an endpoint. More...
 
static void usbus_disable_endpoint (usbus_endpoint_t *ep)
 Disable an endpoint. More...
 
static void usbus_handler_set_flag (usbus_handler_t *handler, uint32_t flag)
 enable a specific handler flag More...
 
static void usbus_handler_remove_flag (usbus_handler_t *handler, uint32_t flag)
 disable a specific handler flag More...
 
static bool usbus_handler_isset_flag (usbus_handler_t *handler, uint32_t flag)
 check if a specific handler flag is set More...
 

USBUS thread flags

Thread flags used by the USBUS thread.

THREAD_FLAG_EVENT is also used, but defined elsewhere

#define USBUS_THREAD_FLAG_USBDEV   (0x02)
 usbdev esr needs handling
 
#define USBUS_THREAD_FLAG_USBDEV_EP   (0x04)
 One or more endpoints requires servicing.
 

USBUS handler subscription flags

#define USBUS_HANDLER_FLAG_RESET   (0x0001)
 Report reset event.
 
#define USBUS_HANDLER_FLAG_SOF   (0x0002)
 Report SOF events.
 
#define USBUS_HANDLER_FLAG_SUSPEND   (0x0004)
 Report suspend events.
 
#define USBUS_HANDLER_FLAG_RESUME   (0x0008)
 Report resume from suspend.
 
#define USBUS_HANDLER_FLAG_TR_FAIL   (0x0010)
 Report transfer fail.
 
#define USBUS_HANDLER_FLAG_TR_STALL   (0x0020)
 Report transfer stall complete.