]> begriffs open source - cmsis/blob - CMSIS/Driver/DriverTemplates/Driver_USBH.c
Merge branch 'release/5.0.0-Beta4'
[cmsis] / CMSIS / Driver / DriverTemplates / Driver_USBH.c
1 /*\r
2  * Copyright (c) 2013-2016 ARM Limited. All rights reserved.\r
3  *\r
4  * SPDX-License-Identifier: Apache-2.0\r
5  *\r
6  * Licensed under the Apache License, Version 2.0 (the License); you may\r
7  * not use this file except in compliance with the License.\r
8  * You may obtain a copy of the License at\r
9  *\r
10  * http://www.apache.org/licenses/LICENSE-2.0\r
11  *\r
12  * Unless required by applicable law or agreed to in writing, software\r
13  * distributed under the License is distributed on an AS IS BASIS, WITHOUT\r
14  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
15  * See the License for the specific language governing permissions and\r
16  * limitations under the License.\r
17  */\r
18  \r
19 #include "Driver_USBH.h"\r
20 \r
21 /* USB Host Driver */\r
22 \r
23 #define ARM_USBH_DRV_VERSION    ARM_DRIVER_VERSION_MAJOR_MINOR(2, 0) /* driver version */\r
24 \r
25 /* Driver Version */\r
26 static const ARM_DRIVER_VERSION usbh_driver_version = { \r
27     ARM_USBH_API_VERSION,\r
28     ARM_USBH_DRV_VERSION\r
29 };\r
30 \r
31 /* Driver Capabilities */\r
32 static const ARM_USBD_CAPABILITIES usbd_driver_capabilities = {\r
33     0x0001, /* Root HUB available Ports Mask   */\r
34     0,      /* Automatic SPLIT packet handling */\r
35     0,      /* Signal Connect event */\r
36     0,      /* Signal Disconnect event */\r
37     0       /* Signal Overcurrent event */\r
38 };\r
39 \r
40 //\r
41 // Functions\r
42 //\r
43 \r
44 ARM_DRIVER_VERSION ARM_USBH_GetVersion(void)\r
45 {\r
46 }\r
47 \r
48 ARM_USBH_CAPABILITIES ARM_USBH_GetCapabilities(void)\r
49 {\r
50 }\r
51 \r
52 int32_t ARM_USBH_Initialize(ARM_USBH_SignalPortEvent_t cb_port_event,\r
53                             ARM_USBH_SignalEndpointEvent_t cb_endpoint_event)\r
54 {\r
55 }\r
56 \r
57 int32_t ARM_USBH_Uninitialize(void)\r
58 {\r
59 }\r
60 \r
61 int32_t ARM_USBH_PowerControl(ARM_POWER_STATE state)\r
62 {\r
63     switch (state)\r
64     {\r
65     case ARM_POWER_OFF:\r
66         break;\r
67 \r
68     case ARM_POWER_LOW:\r
69         break;\r
70 \r
71     case ARM_POWER_FULL:\r
72         break;\r
73 \r
74     default:\r
75         return ARM_DRIVER_ERROR_UNSUPPORTED;\r
76     }\r
77 }\r
78 \r
79 int32_t ARM_USBH_PortVbusOnOff(uint8_t port, bool vbus)\r
80 {\r
81 }\r
82 \r
83 int32_t ARM_USBH_PortReset(uint8_t port)\r
84 {\r
85 }\r
86 \r
87 int32_t ARM_USBH_PortSuspend(uint8_t port)\r
88 {\r
89 }\r
90 \r
91 int32_t ARM_USBH_PortResume(uint8_t port)\r
92 {\r
93 }\r
94 \r
95 ARM_USBH_PORT_STATE ARM_USBH_PortGetState(uint8_t port)\r
96 {\r
97 }\r
98 \r
99 ARM_USBH_EP_HANDLE ARM_USBH_EndpointCreate(uint8_t dev_addr,\r
100                                            uint8_t dev_speed,\r
101                                            uint8_t hub_addr,\r
102                                            uint8_t hub_port,\r
103                                            uint8_t ep_addr,\r
104                                            uint8_t ep_type,\r
105                                            uint16_t ep_max_packet_size,\r
106                                            uint8_t ep_interval)\r
107 {\r
108 }\r
109 \r
110 int32_t ARM_USBH_EndpointModify(ARM_USBH_EP_HANDLE ep_hndl,\r
111                                 uint8_t dev_addr,\r
112                                 uint8_t dev_speed,\r
113                                 uint8_t hub_addr,\r
114                                 uint8_t hub_port,\r
115                                 uint16_t ep_max_packet_size)\r
116 {\r
117 }\r
118 \r
119 int32_t ARM_USBH_EndpointDelete(ARM_USBH_EP_HANDLE ep_hndl)\r
120 {\r
121 }\r
122 \r
123 int32_t ARM_USBH_EndpointReset(ARM_USBH_EP_HANDLE ep_hndl)\r
124 {\r
125 }\r
126 \r
127 int32_t ARM_USBH_EndpointTransfer(ARM_USBH_EP_HANDLE ep_hndl,\r
128                                   uint32_t packet,\r
129                                   uint8_t *data,\r
130                                   uint32_t num)\r
131 {\r
132 }\r
133 \r
134 uint32_t ARM_USBH_EndpointTransferGetResult(ARM_USBH_EP_HANDLE ep_hndl)\r
135 {\r
136 }\r
137 \r
138 int32_t ARM_USBH_EndpointTransferAbort(ARM_USBH_EP_HANDLE ep_hndl)\r
139 {\r
140 }\r
141 \r
142 uint16_t ARM_USBH_GetFrameNumber(void)\r
143 {\r
144 }\r
145 \r
146 void ARM_USBH_SignalPortEvent(uint8_t port, uint32_t event)\r
147 {\r
148     // function body\r
149 }\r
150 \r
151 void ARM_USBH_SignalEndpointEvent(ARM_USBH_EP_HANDLE ep_hndl, uint32_t event)\r
152 {\r
153     // function body\r
154 }\r
155 \r
156 /* USB Host HCI (OHCI/EHCI) Driver */\r
157 \r
158 #define ARM_USBH_HCI_DRV_VERSION    ARM_DRIVER_VERSION_MAJOR_MINOR(2, 0) /* driver version */\r
159 \r
160 /* Driver Version */\r
161 static const ARM_DRIVER_VERSION usbh_hci_driver_version = { \r
162     ARM_USBH_HCI_API_VERSION,\r
163     ARM_USBH_HCI_DRV_VERSION\r
164 };\r
165 \r
166 /* Driver Capabilities */\r
167 static const ARM_USBD_CAPABILITIES usbh_hci_driver_capabilities = {\r
168     0x0001  /* Root HUB available Ports Mask   */\r
169 };\r
170 \r
171 //\r
172 // Functions\r
173 //\r
174 \r
175 ARM_DRIVER_VERSION ARM_USBH_HCI_GetVersion(void)\r
176 {\r
177 }\r
178 \r
179 ARM_USBH_HCI_CAPABILITIES ARM_USBH_HCI_GetCapabilities(void)\r
180 {\r
181 }\r
182 \r
183 int32_t ARM_USBH_HCI_Initialize(ARM_USBH_HCI_Interrupt_t *cb_interrupt)\r
184 {\r
185 }\r
186 \r
187 int32_t ARM_USBH_HCI_Uninitialize(void)\r
188 {\r
189 }\r
190 \r
191 int32_t ARM_USBH_HCI_PowerControl(ARM_POWER_STATE state)\r
192 {\r
193     switch (state)\r
194     {\r
195     case ARM_POWER_OFF:\r
196         break;\r
197 \r
198     case ARM_POWER_LOW:\r
199         break;\r
200 \r
201     case ARM_POWER_FULL:\r
202         break;\r
203 \r
204     default:\r
205         return ARM_DRIVER_ERROR_UNSUPPORTED;\r
206     }\r
207 }\r
208 \r
209 int32_t ARM_USBH_HCI_PortVbusOnOff(uint8_t port, bool vbus)\r
210 {\r
211 }\r
212 \r
213 void ARM_USBH_HCI_Interrupt(void)\r
214 {\r
215     // function body\r
216 }\r
217 \r
218 // End USBH Interface\r
219 \r
220 ARM_DRIVER_USBH_HCI Driver_USBH_HCI = {\r
221     ARM_USBH_HCI_GetVersion,\r
222     ARM_USBH_HCI_GetCapabilities,\r
223     ARM_USBH_HCI_Initialize,\r
224     ARM_USBH_HCI_Uninitialize,\r
225     ARM_USBH_HCI_PowerControl,\r
226     ARM_USBH_HCI_PortVbusOnOff\r
227 };\r