Takanobu Muraguchi / USBDevice

USB device stack

Dependents:   USBMSD_step1 USBMSD_step1_5 picossd_step1_2cs

USBDevice/USBHAL.h@72:c80da04112fd, 2021-02-09 (annotated)

Committer:
muraguchi
Date:
Tue Feb 09 12:00:34 2021 +0000
Revision:
72:c80da04112fd
Parent:
70:2c525a50f1b6 
Initial release

Who changed what in which revision?

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