z ysaito / USBHost3

2018.07.26

Dependencies:   FATFileSystem3 mbed-rtos

Fork of USBHost by mbed official

USBHostHub/USBHostHub.h@43:1675750cca08, 2018-07-26 (annotated)

Committer:
sayzyas
Date:
Thu Jul 26 00:20:32 2018 +0000
Revision:
43:1675750cca08
2018.07.26

Who changed what in which revision?

UserRevisionLine numberNew contents of line
sayzyas 43:1675750cca08 1 /* mbed USBHost Library
sayzyas 43:1675750cca08 2 * Copyright (c) 2006-2013 ARM Limited
sayzyas 43:1675750cca08 3 *
sayzyas 43:1675750cca08 4 * Licensed under the Apache License, Version 2.0 (the "License");
sayzyas 43:1675750cca08 5 * you may not use this file except in compliance with the License.
sayzyas 43:1675750cca08 6 * You may obtain a copy of the License at
sayzyas 43:1675750cca08 7 *
sayzyas 43:1675750cca08 8 * http://www.apache.org/licenses/LICENSE-2.0
sayzyas 43:1675750cca08 9 *
sayzyas 43:1675750cca08 10 * Unless required by applicable law or agreed to in writing, software
sayzyas 43:1675750cca08 11 * distributed under the License is distributed on an "AS IS" BASIS,
sayzyas 43:1675750cca08 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
sayzyas 43:1675750cca08 13 * See the License for the specific language governing permissions and
sayzyas 43:1675750cca08 14 * limitations under the License.
sayzyas 43:1675750cca08 15 */
sayzyas 43:1675750cca08 16
sayzyas 43:1675750cca08 17 #ifndef USBHOSTHUB_H
sayzyas 43:1675750cca08 18 #define USBHOSTHUB_H
sayzyas 43:1675750cca08 19
sayzyas 43:1675750cca08 20 #include "USBHostConf.h"
sayzyas 43:1675750cca08 21
sayzyas 43:1675750cca08 22 #if MAX_HUB_NB
sayzyas 43:1675750cca08 23
sayzyas 43:1675750cca08 24 #include "USBHostTypes.h"
sayzyas 43:1675750cca08 25 #include "IUSBEnumerator.h"
sayzyas 43:1675750cca08 26
sayzyas 43:1675750cca08 27 class USBHost;
sayzyas 43:1675750cca08 28 class USBDeviceConnected;
sayzyas 43:1675750cca08 29 class USBEndpoint;
sayzyas 43:1675750cca08 30
sayzyas 43:1675750cca08 31 /**
sayzyas 43:1675750cca08 32 * A class to use a USB Hub
sayzyas 43:1675750cca08 33 */
sayzyas 43:1675750cca08 34 class USBHostHub : public IUSBEnumerator {
sayzyas 43:1675750cca08 35 public:
sayzyas 43:1675750cca08 36 /**
sayzyas 43:1675750cca08 37 * Constructor
sayzyas 43:1675750cca08 38 */
sayzyas 43:1675750cca08 39 USBHostHub();
sayzyas 43:1675750cca08 40
sayzyas 43:1675750cca08 41 /**
sayzyas 43:1675750cca08 42 * Check if a USB Hub is connected
sayzyas 43:1675750cca08 43 *
sayzyas 43:1675750cca08 44 * @return true if a serial device is connected
sayzyas 43:1675750cca08 45 */
sayzyas 43:1675750cca08 46 bool connected();
sayzyas 43:1675750cca08 47
sayzyas 43:1675750cca08 48 /**
sayzyas 43:1675750cca08 49 * Try to connect device
sayzyas 43:1675750cca08 50 *
sayzyas 43:1675750cca08 51 * @param dev device to connect
sayzyas 43:1675750cca08 52 * @return true if connection was successful
sayzyas 43:1675750cca08 53 */
sayzyas 43:1675750cca08 54 bool connect(USBDeviceConnected * dev);
sayzyas 43:1675750cca08 55
sayzyas 43:1675750cca08 56 /**
sayzyas 43:1675750cca08 57 * Automatically called by USBHost when a device
sayzyas 43:1675750cca08 58 * has been enumerated by usb_thread
sayzyas 43:1675750cca08 59 *
sayzyas 43:1675750cca08 60 * @param dev device connected
sayzyas 43:1675750cca08 61 */
sayzyas 43:1675750cca08 62 void deviceConnected(USBDeviceConnected * dev);
sayzyas 43:1675750cca08 63
sayzyas 43:1675750cca08 64 /**
sayzyas 43:1675750cca08 65 * Automatically called by USBHost when a device
sayzyas 43:1675750cca08 66 * has been disconnected from this hub
sayzyas 43:1675750cca08 67 *
sayzyas 43:1675750cca08 68 * @param dev device disconnected
sayzyas 43:1675750cca08 69 */
sayzyas 43:1675750cca08 70 void deviceDisconnected(USBDeviceConnected * dev);
sayzyas 43:1675750cca08 71
sayzyas 43:1675750cca08 72 /**
sayzyas 43:1675750cca08 73 * Rest a specific port
sayzyas 43:1675750cca08 74 *
sayzyas 43:1675750cca08 75 * @param port port number
sayzyas 43:1675750cca08 76 */
sayzyas 43:1675750cca08 77 void portReset(uint8_t port);
sayzyas 43:1675750cca08 78
sayzyas 43:1675750cca08 79 /*
sayzyas 43:1675750cca08 80 * Called by USBHost to set the instance of USBHost
sayzyas 43:1675750cca08 81 *
sayzyas 43:1675750cca08 82 * @param host host instance
sayzyas 43:1675750cca08 83 */
sayzyas 43:1675750cca08 84 void setHost(USBHost * host);
sayzyas 43:1675750cca08 85
sayzyas 43:1675750cca08 86 /**
sayzyas 43:1675750cca08 87 * Called by USBhost when a hub has been disconnected
sayzyas 43:1675750cca08 88 */
sayzyas 43:1675750cca08 89 void hubDisconnected();
sayzyas 43:1675750cca08 90
sayzyas 43:1675750cca08 91 protected:
sayzyas 43:1675750cca08 92 //From IUSBEnumerator
sayzyas 43:1675750cca08 93 virtual void setVidPid(uint16_t vid, uint16_t pid);
sayzyas 43:1675750cca08 94 virtual bool parseInterface(uint8_t intf_nb, uint8_t intf_class, uint8_t intf_subclass, uint8_t intf_protocol); //Must return true if the interface should be parsed
sayzyas 43:1675750cca08 95 virtual bool useEndpoint(uint8_t intf_nb, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir); //Must return true if the endpoint will be used
sayzyas 43:1675750cca08 96
sayzyas 43:1675750cca08 97 private:
sayzyas 43:1675750cca08 98 USBHost * host;
sayzyas 43:1675750cca08 99 USBDeviceConnected * dev;
sayzyas 43:1675750cca08 100 bool dev_connected;
sayzyas 43:1675750cca08 101 USBEndpoint * int_in;
sayzyas 43:1675750cca08 102 uint8_t nb_port;
sayzyas 43:1675750cca08 103 uint8_t hub_characteristics;
sayzyas 43:1675750cca08 104
sayzyas 43:1675750cca08 105 void rxHandler();
sayzyas 43:1675750cca08 106
sayzyas 43:1675750cca08 107 uint8_t buf[sizeof(HubDescriptor)];
sayzyas 43:1675750cca08 108
sayzyas 43:1675750cca08 109 int hub_intf;
sayzyas 43:1675750cca08 110 bool hub_device_found;
sayzyas 43:1675750cca08 111
sayzyas 43:1675750cca08 112 void setPortFeature(uint32_t feature, uint8_t port);
sayzyas 43:1675750cca08 113 void clearPortFeature(uint32_t feature, uint8_t port);
sayzyas 43:1675750cca08 114 uint32_t getPortStatus(uint8_t port);
sayzyas 43:1675750cca08 115
sayzyas 43:1675750cca08 116 USBDeviceConnected * device_children[MAX_HUB_PORT];
sayzyas 43:1675750cca08 117
sayzyas 43:1675750cca08 118 void init();
sayzyas 43:1675750cca08 119 void disconnect();
sayzyas 43:1675750cca08 120
sayzyas 43:1675750cca08 121 };
sayzyas 43:1675750cca08 122
sayzyas 43:1675750cca08 123 #endif
sayzyas 43:1675750cca08 124
sayzyas 43:1675750cca08 125 #endif