/* * This file is part of the libusbhost library * hosted at http://github.com/libusbhost/libusbhost * * Copyright (C) 2015 Amir Hammad * * * libusbhost 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 3 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. * * You should have received a copy of the GNU Lesser General Public License * along with this library. If not, see . * */ #ifndef USBH_DEVICE_DRIVER_ #define USBH_DEVICE_DRIVER_ #include "usbh_config.h" #include "usbh_core.h" #include BEGIN_DECLS enum USBH_ENDPOINT_TYPE { USBH_ENDPOINT_TYPE_CONTROL = 0, USBH_ENDPOINT_TYPE_ISOCHRONOUS = 1, USBH_ENDPOINT_TYPE_BULK = 2, USBH_ENDPOINT_TYPE_INTERRUPT = 3, }; enum USBH_SPEED { USBH_SPEED_FULL = 0, USBH_SPEED_LOW = 1, USBH_SPEED_HIGH = 2, }; enum USBH_PACKET_CALLBACK_STATUS { USBH_PACKET_CALLBACK_STATUS_OK = 0, USBH_PACKET_CALLBACK_STATUS_ERRSIZ = 1, USBH_PACKET_CALLBACK_STATUS_EAGAIN = 2, // -- TODO: automatic handling of transmit errors 3xTXERR->FATAL USBH_PACKET_CALLBACK_STATUS_EFATAL = 3 }; enum USBH_POLL_STATUS { USBH_POLL_STATUS_NONE, USBH_POLL_STATUS_DEVICE_CONNECTED, USBH_POLL_STATUS_DEVICE_DISCONNECTED }; enum USBH_CONTROL_TYPE { USBH_CONTROL_TYPE_SETUP, USBH_CONTROL_TYPE_DATA }; enum USBH_ENUM_STATE { USBH_ENUM_STATE_SET_ADDRESS, USBH_ENUM_STATE_FIRST = USBH_ENUM_STATE_SET_ADDRESS, USBH_ENUM_STATE_SET_ADDRESS_EMPTY_READ, USBH_ENUM_STATE_SET_ADDRESS_EMPTY_READ_COMPLETE, USBH_ENUM_STATE_DEVICE_DT_READ_SETUP, USBH_ENUM_STATE_DEVICE_DT_READ, USBH_ENUM_STATE_DEVICE_DT_READ_COMPLETE, USBH_ENUM_STATE_CONFIGURATION_DT_HEADER_READ_SETUP, USBH_ENUM_STATE_CONFIGURATION_DT_HEADER_READ, USBH_ENUM_STATE_CONFIGURATION_DT_HEADER_READ_COMPLETE, USBH_ENUM_STATE_CONFIGURATION_DT_READ_SETUP, USBH_ENUM_STATE_CONFIGURATION_DT_READ, USBH_ENUM_STATE_CONFIGURATION_DT_READ_COMPLETE, USBH_ENUM_STATE_FIND_DRIVER, }; /** * @brief The _usbh_device struct * * This represents exactly one connected device. */ struct _usbh_device { /// max packet size for control endpoint(0) uint16_t packet_size_max0; /// Device's address int8_t address; /// @see USBH_SPEED enum USBH_SPEED speed; /// state used for enumeration purposes enum USBH_ENUM_STATE state; /// toggle bit uint8_t toggle0; /** * @brief drv - device driver used for this connected device */ const usbh_dev_driver_t *drv; /** * @brief drvdata - device driver's private data */ void *drvdata; /** * @brief lld - pointer to a low-level driver's instance */ const void *lld; }; typedef struct _usbh_device usbh_device_t; struct _usbh_packet_callback_data { /// status - it is used for reporting of the errors enum USBH_PACKET_CALLBACK_STATUS status; /// count of bytes that has been actually transferred uint32_t transferred_length; }; typedef struct _usbh_packet_callback_data usbh_packet_callback_data_t; typedef void (*usbh_packet_callback_t)(usbh_device_t *dev, usbh_packet_callback_data_t status); struct _usbh_packet { /// pointer to data void *data; /// length of the data (up to 1023) uint16_t datalen; /// Device's address int8_t address; /** * @brief Endpoint type * @see USBH_ENDPOINT_TYPE */ enum USBH_ENDPOINT_TYPE endpoint_type; enum USBH_CONTROL_TYPE control_type; /// Endpoint number 0..15 uint8_t endpoint_address; /// Max packet size for an endpoint uint16_t endpoint_size_max; /// @see USBH_SPEED enum USBH_SPEED speed; uint8_t *toggle; /** * @brief callback this will be called when the packet is finished - either successfuly or not. */ usbh_packet_callback_t callback; /** * @brief callback_arg argument passed into callback * * Low level driver is not allowed to alter the data pointed by callback_arg */ void *callback_arg; }; typedef struct _usbh_packet usbh_packet_t; struct _usbh_low_level_driver { /** * @brief init initialization routine of the low-level driver * * * This function is called during the initialization of the library * * @see usbh_init() */ void (*init)(void *drvdata); /** * write - perform a write to a device * @see usbh_packet_t */ void (*write)(void *drvdata, const usbh_packet_t *packet); /** * @brief read - perform a read from a device * @see usbh_packet_t */ void (*read)(void *drvdata, usbh_packet_t *packet); /** * @brief this is called as a part of @ref usbh_poll() routine */ enum USBH_POLL_STATUS (*poll)(void *drvdata, uint32_t time_curr_us); /** * @brief speed of the low-level bus */ enum USBH_SPEED (*root_speed)(void *drvdata); /** * @brief Pointer to Low-level driver data * * Data pointed by this pointer should not be altered by the logic other from low-level driver's logic */ void *driver_data; }; typedef struct _usbh_low_level_driver usbh_low_level_driver_t; struct _usbh_generic_data { usbh_device_t usbh_device[USBH_MAX_DEVICES]; uint8_t usbh_buffer[BUFFER_ONE_BYTES]; }; typedef struct _usbh_generic_data usbh_generic_data_t; #define ERROR(arg) LOG_PRINTF("UNHANDLED_ERROR %d: file: %s, line: %d",\ arg, __FILE__, __LINE__) /* Hub related functions */ usbh_device_t *usbh_get_free_device(const usbh_device_t *dev); bool usbh_enum_available(void); void device_enumeration_start(usbh_device_t *dev); /* All devices functions */ void usbh_read(usbh_device_t *dev, usbh_packet_t *packet); void usbh_write(usbh_device_t *dev, const usbh_packet_t *packet); /* Helper functions used by device drivers */ void device_xfer_control_read(void *data, uint16_t datalen, usbh_packet_callback_t callback, usbh_device_t *dev); void device_xfer_control_write_setup(void *data, uint16_t datalen, usbh_packet_callback_t callback, usbh_device_t *dev); void device_xfer_control_write_data(void *data, uint16_t datalen, usbh_packet_callback_t callback, usbh_device_t *dev); END_DECLS #endif