usbh_hcd.h

Go to the documentation of this file.

/**************************************************************************/
/**************************************************************************/

#ifndef _TUSB_USBH_HCD_H_
#define _TUSB_USBH_HCD_H_

#ifdef __cplusplus
 extern "C" {
#endif

//--------------------------------------------------------------------+
// INCLUDE
//--------------------------------------------------------------------+
#include "common/common.h"

#ifdef _TEST_
#include "hcd.h"
#include "osal.h"
#endif

//--------------------------------------------------------------------+
// USBH-HCD common data structure
//--------------------------------------------------------------------+
typedef struct ATTR_ALIGNED(4){
  uint8_t core_id;
  uint8_t hub_addr;
  uint8_t hub_port;
  uint8_t reserve;
} usbh_enumerate_t;

typedef struct {
  //------------- port -------------//
  uint8_t core_id;
  uint8_t hub_addr;
  uint8_t hub_port;
  uint8_t speed;

  //------------- device descriptor -------------//
  uint16_t vendor_id;
  uint16_t product_id;
  uint8_t  configure_count; // bNumConfigurations alias

  //------------- configuration descriptor -------------//
  uint8_t interface_count; // bNumInterfaces alias

  //------------- device -------------//
  volatile uint8_t state;             // device state, value from enum tusbh_device_state_t
  uint32_t flag_supported_class;      // a bitmap of supported class

  //------------- control pipe -------------//
  struct {
    volatile uint8_t pipe_status;
//    uint8_t xferred_bytes; TODO not yet necessary
    tusb_control_request_t request;

    OSAL_SEM_DEF(semaphore);          // TODO move to semaphore pool ?
    osal_semaphore_handle_t sem_hdl;  // used to synchronize with HCD when control xfer complete

    OSAL_MUTEX_DEF(mutex);            // TODO move to mutex pool ?
    osal_mutex_handle_t mutex_hdl;    // used to exclusively occupy control pipe
  } control;
} usbh_device_info_t;

extern usbh_device_info_t usbh_devices[TUSB_CFG_HOST_DEVICE_MAX+1]; // including zero-address

//--------------------------------------------------------------------+
// callback from HCD ISR
//--------------------------------------------------------------------+
void usbh_xfer_isr(pipe_handle_t pipe_hdl, uint8_t class_code, tusb_event_t event, uint32_t xferred_bytes);
void usbh_hcd_rhport_plugged_isr(uint8_t hostid);
void usbh_hcd_rhport_unplugged_isr(uint8_t hostid);

#ifdef __cplusplus
 }
#endif

#endif /* _TUSB_USBH_HCD_H_ */