Patrick Pollet / USBDevice

usb device

USBDevice/USBHAL.h@0:c1e89c49eae5, 2022-05-14 (annotated)

Committer:
ppo
Date:
Sat May 14 17:24:10 2022 +0000
Revision:
0:c1e89c49eae5
commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ppo 0:c1e89c49eae5 1 /* Copyright (c) 2010-2011 mbed.org, MIT License
ppo 0:c1e89c49eae5 2 *
ppo 0:c1e89c49eae5 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
ppo 0:c1e89c49eae5 4 * and associated documentation files (the "Software"), to deal in the Software without
ppo 0:c1e89c49eae5 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
ppo 0:c1e89c49eae5 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
ppo 0:c1e89c49eae5 7 * Software is furnished to do so, subject to the following conditions:
ppo 0:c1e89c49eae5 8 *
ppo 0:c1e89c49eae5 9 * The above copyright notice and this permission notice shall be included in all copies or
ppo 0:c1e89c49eae5 10 * substantial portions of the Software.
ppo 0:c1e89c49eae5 11 *
ppo 0:c1e89c49eae5 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
ppo 0:c1e89c49eae5 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
ppo 0:c1e89c49eae5 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
ppo 0:c1e89c49eae5 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
ppo 0:c1e89c49eae5 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
ppo 0:c1e89c49eae5 17 */
ppo 0:c1e89c49eae5 18
ppo 0:c1e89c49eae5 19 #ifndef USBBUSINTERFACE_H
ppo 0:c1e89c49eae5 20 #define USBBUSINTERFACE_H
ppo 0:c1e89c49eae5 21
ppo 0:c1e89c49eae5 22 #include "mbed.h"
ppo 0:c1e89c49eae5 23 #include "USBEndpoints.h"
ppo 0:c1e89c49eae5 24
ppo 0:c1e89c49eae5 25 class USBHAL {
ppo 0:c1e89c49eae5 26 public:
ppo 0:c1e89c49eae5 27 /* Configuration */
ppo 0:c1e89c49eae5 28 USBHAL();
ppo 0:c1e89c49eae5 29 ~USBHAL();
ppo 0:c1e89c49eae5 30 void connect(void);
ppo 0:c1e89c49eae5 31 void disconnect(void);
ppo 0:c1e89c49eae5 32 void configureDevice(void);
ppo 0:c1e89c49eae5 33 void unconfigureDevice(void);
ppo 0:c1e89c49eae5 34 void setAddress(uint8_t address);
ppo 0:c1e89c49eae5 35 void remoteWakeup(void);
ppo 0:c1e89c49eae5 36
ppo 0:c1e89c49eae5 37 /* Endpoint 0 */
ppo 0:c1e89c49eae5 38 void EP0setup(uint8_t *buffer);
ppo 0:c1e89c49eae5 39 void EP0read(void);
ppo 0:c1e89c49eae5 40 uint32_t EP0getReadResult(uint8_t *buffer);
ppo 0:c1e89c49eae5 41 void EP0write(uint8_t *buffer, uint32_t size);
ppo 0:c1e89c49eae5 42 void EP0getWriteResult(void);
ppo 0:c1e89c49eae5 43 void EP0stall(void);
ppo 0:c1e89c49eae5 44
ppo 0:c1e89c49eae5 45 /* Other endpoints */
ppo 0:c1e89c49eae5 46 EP_STATUS endpointRead(uint8_t endpoint, uint32_t maximumSize);
ppo 0:c1e89c49eae5 47 EP_STATUS endpointReadResult(uint8_t endpoint, uint8_t *data, uint32_t *bytesRead);
ppo 0:c1e89c49eae5 48 EP_STATUS endpointWrite(uint8_t endpoint, uint8_t *data, uint32_t size);
ppo 0:c1e89c49eae5 49 EP_STATUS endpointWriteResult(uint8_t endpoint);
ppo 0:c1e89c49eae5 50 void stallEndpoint(uint8_t endpoint);
ppo 0:c1e89c49eae5 51 void unstallEndpoint(uint8_t endpoint);
ppo 0:c1e89c49eae5 52 bool realiseEndpoint(uint8_t endpoint, uint32_t maxPacket, uint32_t options);
ppo 0:c1e89c49eae5 53 bool getEndpointStallState(unsigned char endpoint);
ppo 0:c1e89c49eae5 54 uint32_t endpointReadcore(uint8_t endpoint, uint8_t *buffer);
ppo 0:c1e89c49eae5 55
ppo 0:c1e89c49eae5 56 protected:
ppo 0:c1e89c49eae5 57 virtual void busReset(void){};
ppo 0:c1e89c49eae5 58 virtual void EP0setupCallback(void){};
ppo 0:c1e89c49eae5 59 virtual void EP0out(void){};
ppo 0:c1e89c49eae5 60 virtual void EP0in(void){};
ppo 0:c1e89c49eae5 61 virtual void connectStateChanged(unsigned int connected){};
ppo 0:c1e89c49eae5 62 virtual void suspendStateChanged(unsigned int suspended){};
ppo 0:c1e89c49eae5 63 virtual void SOF(int frameNumber){};
ppo 0:c1e89c49eae5 64 virtual bool EP1_OUT_callback(){return false;};
ppo 0:c1e89c49eae5 65 virtual bool EP1_IN_callback(){return false;};
ppo 0:c1e89c49eae5 66 virtual bool EP2_OUT_callback(){return false;};
ppo 0:c1e89c49eae5 67 virtual bool EP2_IN_callback(){return false;};
ppo 0:c1e89c49eae5 68 virtual bool EP3_OUT_callback(){return false;};
ppo 0:c1e89c49eae5 69 virtual bool EP3_IN_callback(){return false;};
ppo 0:c1e89c49eae5 70
ppo 0:c1e89c49eae5 71 private:
ppo 0:c1e89c49eae5 72 void usbisr(void);
ppo 0:c1e89c49eae5 73 static void _usbisr(void);
ppo 0:c1e89c49eae5 74 static USBHAL * instance;
ppo 0:c1e89c49eae5 75 };
ppo 0:c1e89c49eae5 76 #endif
ppo 0:c1e89c49eae5 77