Helmut Tschemernjak / USBDeviceHT

A copy of the mbed USBDevice with USBSerial library

Dependents:   STM32L0_LoRa Smartage STM32L0_LoRa Turtle_RadioShuttle

USBDevice/USBHAL.h@8:961423d1da74, 2019-02-24 (annotated)

Committer:
Helmut Tschemernjak
Date:
Sun Feb 24 14:52:33 2019 +0100
Revision:
8:961423d1da74
Parent:
0:a3ea811f80f2 
Added sleep manager support to avoids sleeps while a USB CDC

connection is active

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Helmut64 0:a3ea811f80f2 1 /* Copyright (c) 2010-2011 mbed.org, MIT License
Helmut64 0:a3ea811f80f2 2 *
Helmut64 0:a3ea811f80f2 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
Helmut64 0:a3ea811f80f2 4 * and associated documentation files (the "Software"), to deal in the Software without
Helmut64 0:a3ea811f80f2 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
Helmut64 0:a3ea811f80f2 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
Helmut64 0:a3ea811f80f2 7 * Software is furnished to do so, subject to the following conditions:
Helmut64 0:a3ea811f80f2 8 *
Helmut64 0:a3ea811f80f2 9 * The above copyright notice and this permission notice shall be included in all copies or
Helmut64 0:a3ea811f80f2 10 * substantial portions of the Software.
Helmut64 0:a3ea811f80f2 11 *
Helmut64 0:a3ea811f80f2 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
Helmut64 0:a3ea811f80f2 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
Helmut64 0:a3ea811f80f2 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
Helmut64 0:a3ea811f80f2 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
Helmut64 0:a3ea811f80f2 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Helmut64 0:a3ea811f80f2 17 */
Helmut64 0:a3ea811f80f2 18
Helmut64 0:a3ea811f80f2 19 #ifndef USBBUSINTERFACE_H
Helmut64 0:a3ea811f80f2 20 #define USBBUSINTERFACE_H
Helmut64 0:a3ea811f80f2 21
Helmut64 0:a3ea811f80f2 22 #include "mbed.h"
Helmut64 0:a3ea811f80f2 23 #include "USBEndpoints.h"
Helmut64 0:a3ea811f80f2 24 #include "mbed_toolchain.h"
Helmut64 0:a3ea811f80f2 25
Helmut64 0:a3ea811f80f2 26 //#ifdef __GNUC__
Helmut64 0:a3ea811f80f2 27 //#define __packed __attribute__ ((__packed__))
Helmut64 0:a3ea811f80f2 28 //#endif
Helmut64 0:a3ea811f80f2 29
Helmut64 0:a3ea811f80f2 30 class USBHAL {
Helmut64 0:a3ea811f80f2 31 public:
Helmut64 0:a3ea811f80f2 32 /* Configuration */
Helmut64 0:a3ea811f80f2 33 USBHAL();
Helmut64 0:a3ea811f80f2 34 ~USBHAL();
Helmut64 0:a3ea811f80f2 35 void connect(void);
Helmut64 0:a3ea811f80f2 36 void disconnect(void);
Helmut64 0:a3ea811f80f2 37 void configureDevice(void);
Helmut64 0:a3ea811f80f2 38 void unconfigureDevice(void);
Helmut64 0:a3ea811f80f2 39 void setAddress(uint8_t address);
Helmut64 0:a3ea811f80f2 40 void remoteWakeup(void);
Helmut64 0:a3ea811f80f2 41
Helmut64 0:a3ea811f80f2 42 /* Endpoint 0 */
Helmut64 0:a3ea811f80f2 43 void EP0setup(uint8_t *buffer);
Helmut64 0:a3ea811f80f2 44 void EP0read(void);
Helmut64 0:a3ea811f80f2 45 void EP0readStage(void);
Helmut64 0:a3ea811f80f2 46 uint32_t EP0getReadResult(uint8_t *buffer);
Helmut64 0:a3ea811f80f2 47 void EP0write(uint8_t *buffer, uint32_t size);
Helmut64 0:a3ea811f80f2 48 void EP0getWriteResult(void);
Helmut64 0:a3ea811f80f2 49 void EP0stall(void);
Helmut64 0:a3ea811f80f2 50
Helmut64 0:a3ea811f80f2 51 /* Other endpoints */
Helmut64 0:a3ea811f80f2 52 EP_STATUS endpointRead(uint8_t endpoint, uint32_t maximumSize);
Helmut64 0:a3ea811f80f2 53 EP_STATUS endpointReadResult(uint8_t endpoint, uint8_t *data, uint32_t *bytesRead);
Helmut64 0:a3ea811f80f2 54 EP_STATUS endpointWrite(uint8_t endpoint, uint8_t *data, uint32_t size);
Helmut64 0:a3ea811f80f2 55 EP_STATUS endpointWriteResult(uint8_t endpoint);
Helmut64 0:a3ea811f80f2 56 void stallEndpoint(uint8_t endpoint);
Helmut64 0:a3ea811f80f2 57 void unstallEndpoint(uint8_t endpoint);
Helmut64 0:a3ea811f80f2 58 bool realiseEndpoint(uint8_t endpoint, uint32_t maxPacket, uint32_t options);
Helmut64 0:a3ea811f80f2 59 bool getEndpointStallState(unsigned char endpoint);
Helmut64 0:a3ea811f80f2 60 uint32_t endpointReadcore(uint8_t endpoint, uint8_t *buffer);
Helmut64 0:a3ea811f80f2 61
Helmut64 0:a3ea811f80f2 62 protected:
Helmut64 0:a3ea811f80f2 63 virtual void busReset(void){};
Helmut64 0:a3ea811f80f2 64 virtual void EP0setupCallback(void){};
Helmut64 0:a3ea811f80f2 65 virtual void EP0out(void){};
Helmut64 0:a3ea811f80f2 66 virtual void EP0in(void){};
Helmut64 0:a3ea811f80f2 67 virtual void connectStateChanged(unsigned int connected){};
Helmut64 0:a3ea811f80f2 68 virtual void suspendStateChanged(unsigned int suspended){};
Helmut64 0:a3ea811f80f2 69 virtual void SOF(int frameNumber){};
Helmut64 0:a3ea811f80f2 70
Helmut64 0:a3ea811f80f2 71 #if defined(TARGET_NUC472) || defined(TARGET_M451)
Helmut64 0:a3ea811f80f2 72 // NUC472/M451 USB doesn't support configuration of the same EP number for IN/OUT simultaneously.
Helmut64 0:a3ea811f80f2 73 virtual bool EP1_OUT_callback(){return false;};
Helmut64 0:a3ea811f80f2 74 virtual bool EP2_IN_callback(){return false;};
Helmut64 0:a3ea811f80f2 75 virtual bool EP3_OUT_callback(){return false;};
Helmut64 0:a3ea811f80f2 76 virtual bool EP4_IN_callback(){return false;};
Helmut64 0:a3ea811f80f2 77 virtual bool EP5_OUT_callback(){return false;};
Helmut64 0:a3ea811f80f2 78 virtual bool EP6_IN_callback(){return false;};
Helmut64 0:a3ea811f80f2 79 #if ! (defined(TARGET_M451))
Helmut64 0:a3ea811f80f2 80 virtual bool EP7_OUT_callback(){return false;};
Helmut64 0:a3ea811f80f2 81 virtual bool EP8_IN_callback(){return false;};
Helmut64 0:a3ea811f80f2 82 virtual bool EP9_OUT_callback(){return false;};
Helmut64 0:a3ea811f80f2 83 virtual bool EP10_IN_callback(){return false;};
Helmut64 0:a3ea811f80f2 84 virtual bool EP11_OUT_callback(){return false;};
Helmut64 0:a3ea811f80f2 85 virtual bool EP12_IN_callback(){return false;};
Helmut64 0:a3ea811f80f2 86 #endif
Helmut64 0:a3ea811f80f2 87 #else
Helmut64 0:a3ea811f80f2 88 virtual bool EP1_OUT_callback(){return false;};
Helmut64 0:a3ea811f80f2 89 virtual bool EP1_IN_callback(){return false;};
Helmut64 0:a3ea811f80f2 90 virtual bool EP2_OUT_callback(){return false;};
Helmut64 0:a3ea811f80f2 91 virtual bool EP2_IN_callback(){return false;};
Helmut64 0:a3ea811f80f2 92 virtual bool EP3_OUT_callback(){return false;};
Helmut64 0:a3ea811f80f2 93 virtual bool EP3_IN_callback(){return false;};
Helmut64 0:a3ea811f80f2 94 #if !defined(TARGET_STM32F4)
Helmut64 0:a3ea811f80f2 95 virtual bool EP4_OUT_callback(){return false;};
Helmut64 0:a3ea811f80f2 96 virtual bool EP4_IN_callback(){return false;};
Helmut64 0:a3ea811f80f2 97 #if !(defined(TARGET_LPC11UXX) || defined(TARGET_LPC11U6X) || defined(TARGET_LPC1347) || defined(TARGET_LPC1549))
Helmut64 0:a3ea811f80f2 98 virtual bool EP5_OUT_callback(){return false;};
Helmut64 0:a3ea811f80f2 99 virtual bool EP5_IN_callback(){return false;};
Helmut64 0:a3ea811f80f2 100 virtual bool EP6_OUT_callback(){return false;};
Helmut64 0:a3ea811f80f2 101 virtual bool EP6_IN_callback(){return false;};
Helmut64 0:a3ea811f80f2 102 virtual bool EP7_OUT_callback(){return false;};
Helmut64 0:a3ea811f80f2 103 virtual bool EP7_IN_callback(){return false;};
Helmut64 0:a3ea811f80f2 104 virtual bool EP8_OUT_callback(){return false;};
Helmut64 0:a3ea811f80f2 105 virtual bool EP8_IN_callback(){return false;};
Helmut64 0:a3ea811f80f2 106 virtual bool EP9_OUT_callback(){return false;};
Helmut64 0:a3ea811f80f2 107 virtual bool EP9_IN_callback(){return false;};
Helmut64 0:a3ea811f80f2 108 virtual bool EP10_OUT_callback(){return false;};
Helmut64 0:a3ea811f80f2 109 virtual bool EP10_IN_callback(){return false;};
Helmut64 0:a3ea811f80f2 110 virtual bool EP11_OUT_callback(){return false;};
Helmut64 0:a3ea811f80f2 111 virtual bool EP11_IN_callback(){return false;};
Helmut64 0:a3ea811f80f2 112 virtual bool EP12_OUT_callback(){return false;};
Helmut64 0:a3ea811f80f2 113 virtual bool EP12_IN_callback(){return false;};
Helmut64 0:a3ea811f80f2 114 virtual bool EP13_OUT_callback(){return false;};
Helmut64 0:a3ea811f80f2 115 virtual bool EP13_IN_callback(){return false;};
Helmut64 0:a3ea811f80f2 116 virtual bool EP14_OUT_callback(){return false;};
Helmut64 0:a3ea811f80f2 117 virtual bool EP14_IN_callback(){return false;};
Helmut64 0:a3ea811f80f2 118 virtual bool EP15_OUT_callback(){return false;};
Helmut64 0:a3ea811f80f2 119 virtual bool EP15_IN_callback(){return false;};
Helmut64 0:a3ea811f80f2 120 #endif
Helmut64 0:a3ea811f80f2 121 #endif
Helmut64 0:a3ea811f80f2 122 #endif
Helmut64 0:a3ea811f80f2 123
Helmut64 0:a3ea811f80f2 124 private:
Helmut64 0:a3ea811f80f2 125 void usbisr(void);
Helmut64 0:a3ea811f80f2 126 static void _usbisr(void);
Helmut64 0:a3ea811f80f2 127 static USBHAL * instance;
Helmut64 0:a3ea811f80f2 128
Helmut64 0:a3ea811f80f2 129 #if defined(TARGET_LPC11UXX) || defined(TARGET_LPC11U6X) || defined(TARGET_LPC1347) || defined(TARGET_LPC1549)
Helmut64 0:a3ea811f80f2 130 bool (USBHAL::*epCallback[10 - 2])(void);
Helmut64 0:a3ea811f80f2 131 #elif (defined(TARGET_STM32F4) && !defined(USB_STM_HAL)) || defined(TARGET_M451)
Helmut64 0:a3ea811f80f2 132 bool (USBHAL::*epCallback[8 - 2])(void);
Helmut64 0:a3ea811f80f2 133 #elif defined(TARGET_STM)
Helmut64 0:a3ea811f80f2 134 PCD_HandleTypeDef hpcd;
Helmut64 0:a3ea811f80f2 135 #elif defined(TARGET_NUC472) || defined(TARGET_M480)
Helmut64 0:a3ea811f80f2 136 bool (USBHAL::*epCallback[14 - 2])(void);
Helmut64 0:a3ea811f80f2 137 #else
Helmut64 0:a3ea811f80f2 138 bool (USBHAL::*epCallback[32 - 2])(void);
Helmut64 0:a3ea811f80f2 139 #endif
Helmut64 0:a3ea811f80f2 140
Helmut64 0:a3ea811f80f2 141
Helmut64 0:a3ea811f80f2 142 };
Helmut64 0:a3ea811f80f2 143 #endif