2 * Copyright (c) 2013-2020 ARM Limited. All rights reserved.
4 * SPDX-License-Identifier: Apache-2.0
6 * Licensed under the Apache License, Version 2.0 (the License); you may
7 * not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an AS IS BASIS, WITHOUT
14 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
18 * $Date: 24. January 2020
21 * Project: USB Host Driver definitions
26 * Removed volatile from ARM_USBH_PORT_STATE
28 * ARM_USBH_PORT_STATE made volatile
30 * Renamed structure ARM_USBH_EP_HANDLE to ARM_USBH_PIPE_HANDLE
31 * Renamed functions ARM_USBH_Endpoint... to ARM_USBH_Pipe...
32 * Renamed function ARM_USBH_SignalEndpointEvent to ARM_USBH_SignalPipeEvent
34 * Replaced function ARM_USBH_PortPowerOnOff with ARM_USBH_PortVbusOnOff
35 * Changed function ARM_USBH_EndpointCreate parameters
36 * Replaced function ARM_USBH_EndpointConfigure with ARM_USBH_EndpointModify
37 * Replaced function ARM_USBH_EndpointClearHalt with ARM_USBH_EndpointReset
38 * Replaced function ARM_USBH_URB_Submit with ARM_USBH_EndpointTransfer
39 * Replaced function ARM_USBH_URB_Abort with ARM_USBH_EndpointTransferAbort
40 * Added function ARM_USBH_EndpointTransferGetResult
41 * Added function ARM_USBH_GetFrameNumber
42 * Changed prefix ARM_DRV -> ARM_DRIVER
44 * Added API for OHCI/EHCI Host Controller Interface (HCI)
46 * Namespace prefix ARM_ added
51 #ifndef DRIVER_USBH_H_
52 #define DRIVER_USBH_H_
59 #include "Driver_USB.h"
61 #define ARM_USBH_API_VERSION ARM_DRIVER_VERSION_MAJOR_MINOR(2,3) /* API version */
65 \brief USB Host Port State
67 typedef struct _ARM_USBH_PORT_STATE {
68 uint32_t connected : 1; ///< USB Host Port connected flag
69 uint32_t overcurrent : 1; ///< USB Host Port overcurrent flag
70 uint32_t speed : 2; ///< USB Host Port speed setting (ARM_USB_SPEED_xxx)
71 uint32_t reserved : 28;
72 } ARM_USBH_PORT_STATE;
75 \brief USB Host Pipe Handle
77 typedef uint32_t ARM_USBH_PIPE_HANDLE;
78 #define ARM_USBH_EP_HANDLE ARM_USBH_PIPE_HANDLE /* Legacy name */
81 /****** USB Host Packet Information *****/
82 #define ARM_USBH_PACKET_TOKEN_Pos 0
83 #define ARM_USBH_PACKET_TOKEN_Msk (0x0FUL << ARM_USBH_PACKET_TOKEN_Pos)
84 #define ARM_USBH_PACKET_SETUP (0x01UL << ARM_USBH_PACKET_TOKEN_Pos) ///< SETUP Packet
85 #define ARM_USBH_PACKET_OUT (0x02UL << ARM_USBH_PACKET_TOKEN_Pos) ///< OUT Packet
86 #define ARM_USBH_PACKET_IN (0x03UL << ARM_USBH_PACKET_TOKEN_Pos) ///< IN Packet
87 #define ARM_USBH_PACKET_PING (0x04UL << ARM_USBH_PACKET_TOKEN_Pos) ///< PING Packet
89 #define ARM_USBH_PACKET_DATA_Pos 4
90 #define ARM_USBH_PACKET_DATA_Msk (0x0FUL << ARM_USBH_PACKET_DATA_Pos)
91 #define ARM_USBH_PACKET_DATA0 (0x01UL << ARM_USBH_PACKET_DATA_Pos) ///< DATA0 PID
92 #define ARM_USBH_PACKET_DATA1 (0x02UL << ARM_USBH_PACKET_DATA_Pos) ///< DATA1 PID
94 #define ARM_USBH_PACKET_SPLIT_Pos 8
95 #define ARM_USBH_PACKET_SPLIT_Msk (0x0FUL << ARM_USBH_PACKET_SPLIT_Pos)
96 #define ARM_USBH_PACKET_SSPLIT (0x08UL << ARM_USBH_PACKET_SPLIT_Pos) ///< SSPLIT Packet
97 #define ARM_USBH_PACKET_SSPLIT_S (0x09UL << ARM_USBH_PACKET_SPLIT_Pos) ///< SSPLIT Packet: Data Start
98 #define ARM_USBH_PACKET_SSPLIT_E (0x0AUL << ARM_USBH_PACKET_SPLIT_Pos) ///< SSPLIT Packet: Data End
99 #define ARM_USBH_PACKET_SSPLIT_S_E (0x0BUL << ARM_USBH_PACKET_SPLIT_Pos) ///< SSPLIT Packet: Data All
100 #define ARM_USBH_PACKET_CSPLIT (0x0CUL << ARM_USBH_PACKET_SPLIT_Pos) ///< CSPLIT Packet
102 #define ARM_USBH_PACKET_PRE (1UL << 12) ///< PRE Token
105 /****** USB Host Port Event *****/
106 #define ARM_USBH_EVENT_CONNECT (1UL << 0) ///< USB Device Connected to Port
107 #define ARM_USBH_EVENT_DISCONNECT (1UL << 1) ///< USB Device Disconnected from Port
108 #define ARM_USBH_EVENT_OVERCURRENT (1UL << 2) ///< USB Device caused Overcurrent
109 #define ARM_USBH_EVENT_RESET (1UL << 3) ///< USB Reset completed
110 #define ARM_USBH_EVENT_SUSPEND (1UL << 4) ///< USB Suspend occurred
111 #define ARM_USBH_EVENT_RESUME (1UL << 5) ///< USB Resume occurred
112 #define ARM_USBH_EVENT_REMOTE_WAKEUP (1UL << 6) ///< USB Device activated Remote Wakeup
114 /****** USB Host Pipe Event *****/
115 #define ARM_USBH_EVENT_TRANSFER_COMPLETE (1UL << 0) ///< Transfer completed
116 #define ARM_USBH_EVENT_HANDSHAKE_NAK (1UL << 1) ///< NAK Handshake received
117 #define ARM_USBH_EVENT_HANDSHAKE_NYET (1UL << 2) ///< NYET Handshake received
118 #define ARM_USBH_EVENT_HANDSHAKE_MDATA (1UL << 3) ///< MDATA Handshake received
119 #define ARM_USBH_EVENT_HANDSHAKE_STALL (1UL << 4) ///< STALL Handshake received
120 #define ARM_USBH_EVENT_HANDSHAKE_ERR (1UL << 5) ///< ERR Handshake received
121 #define ARM_USBH_EVENT_BUS_ERROR (1UL << 6) ///< Bus Error detected
124 #ifndef __DOXYGEN_MW__ // exclude from middleware documentation
126 // Function documentation
128 \fn ARM_DRIVER_VERSION ARM_USBH_GetVersion (void)
129 \brief Get driver version.
130 \return \ref ARM_DRIVER_VERSION
133 \fn ARM_USBH_CAPABILITIES ARM_USBH_GetCapabilities (void)
134 \brief Get driver capabilities.
135 \return \ref ARM_USBH_CAPABILITIES
138 \fn int32_t ARM_USBH_Initialize (ARM_USBH_SignalPortEvent_t cb_port_event,
139 ARM_USBH_SignalPipeEvent_t cb_pipe_event)
140 \brief Initialize USB Host Interface.
141 \param[in] cb_port_event Pointer to \ref ARM_USBH_SignalPortEvent
142 \param[in] cb_pipe_event Pointer to \ref ARM_USBH_SignalPipeEvent
143 \return \ref execution_status
146 \fn int32_t ARM_USBH_Uninitialize (void)
147 \brief De-initialize USB Host Interface.
148 \return \ref execution_status
151 \fn int32_t ARM_USBH_PowerControl (ARM_POWER_STATE state)
152 \brief Control USB Host Interface Power.
153 \param[in] state Power state
154 \return \ref execution_status
157 \fn int32_t ARM_USBH_PortVbusOnOff (uint8_t port, bool vbus)
158 \brief Root HUB Port VBUS on/off.
159 \param[in] port Root HUB Port Number
163 \return \ref execution_status
166 \fn int32_t ARM_USBH_PortReset (uint8_t port)
167 \brief Do Root HUB Port Reset.
168 \param[in] port Root HUB Port Number
169 \return \ref execution_status
172 \fn int32_t ARM_USBH_PortSuspend (uint8_t port)
173 \brief Suspend Root HUB Port (stop generating SOFs).
174 \param[in] port Root HUB Port Number
175 \return \ref execution_status
178 \fn int32_t ARM_USBH_PortResume (uint8_t port)
179 \brief Resume Root HUB Port (start generating SOFs).
180 \param[in] port Root HUB Port Number
181 \return \ref execution_status
184 \fn ARM_USBH_PORT_STATE ARM_USBH_PortGetState (uint8_t port)
185 \brief Get current Root HUB Port State.
186 \param[in] port Root HUB Port Number
187 \return Port State \ref ARM_USBH_PORT_STATE
190 \fn ARM_USBH_PIPE_HANDLE ARM_USBH_PipeCreate (uint8_t dev_addr,
196 uint16_t ep_max_packet_size,
198 \brief Create Pipe in System.
199 \param[in] dev_addr Device Address
200 \param[in] dev_speed Device Speed
201 \param[in] hub_addr Hub Address
202 \param[in] hub_port Hub Port
203 \param[in] ep_addr Endpoint Address
204 - ep_addr.0..3: Address
205 - ep_addr.7: Direction
206 \param[in] ep_type Endpoint Type (ARM_USB_ENDPOINT_xxx)
207 \param[in] ep_max_packet_size Endpoint Maximum Packet Size
208 \param[in] ep_interval Endpoint Polling Interval
209 \return Pipe Handle \ref ARM_USBH_PIPE_HANDLE
212 \fn int32_t ARM_USBH_PipeModify (ARM_USBH_PIPE_HANDLE pipe_hndl,
217 uint16_t ep_max_packet_size)
218 \brief Modify Pipe in System.
219 \param[in] pipe_hndl Pipe Handle
220 \param[in] dev_addr Device Address
221 \param[in] dev_speed Device Speed
222 \param[in] hub_addr Hub Address
223 \param[in] hub_port Hub Port
224 \param[in] ep_max_packet_size Endpoint Maximum Packet Size
225 \return \ref execution_status
228 \fn int32_t ARM_USBH_PipeDelete (ARM_USBH_PIPE_HANDLE pipe_hndl)
229 \brief Delete Pipe from System.
230 \param[in] pipe_hndl Pipe Handle
231 \return \ref execution_status
234 \fn int32_t ARM_USBH_PipeReset (ARM_USBH_PIPE_HANDLE pipe_hndl)
236 \param[in] pipe_hndl Pipe Handle
237 \return \ref execution_status
240 \fn int32_t ARM_USBH_PipeTransfer (ARM_USBH_PIPE_HANDLE pipe_hndl,
244 \brief Transfer packets through USB Pipe.
245 \param[in] pipe_hndl Pipe Handle
246 \param[in] packet Packet information
247 \param[in] data Pointer to buffer with data to send or for data to receive
248 \param[in] num Number of data bytes to transfer
249 \return \ref execution_status
252 \fn uint32_t ARM_USBH_PipeTransferGetResult (ARM_USBH_PIPE_HANDLE pipe_hndl)
253 \brief Get result of USB Pipe transfer.
254 \param[in] pipe_hndl Pipe Handle
255 \return number of successfully transferred data bytes
258 \fn int32_t ARM_USBH_PipeTransferAbort (ARM_USBH_PIPE_HANDLE pipe_hndl)
259 \brief Abort current USB Pipe transfer.
260 \param[in] pipe_hndl Pipe Handle
261 \return \ref execution_status
264 \fn uint16_t ARM_USBH_GetFrameNumber (void)
265 \brief Get current USB Frame Number.
270 \fn void ARM_USBH_SignalPortEvent (uint8_t port, uint32_t event)
271 \brief Signal Root HUB Port Event.
272 \param[in] port Root HUB Port Number
273 \param[in] event \ref USBH_port_events
277 \fn void ARM_USBH_SignalPipeEvent (ARM_USBH_PIPE_HANDLE pipe_hndl, uint32_t event)
278 \brief Signal Pipe Event.
279 \param[in] pipe_hndl Pipe Handle
280 \param[in] event \ref USBH_pipe_events
284 typedef void (*ARM_USBH_SignalPortEvent_t) (uint8_t port, uint32_t event); ///< Pointer to \ref ARM_USBH_SignalPortEvent : Signal Root HUB Port Event.
285 typedef void (*ARM_USBH_SignalPipeEvent_t) (ARM_USBH_PIPE_HANDLE pipe_hndl, uint32_t event); ///< Pointer to \ref ARM_USBH_SignalPipeEvent : Signal Pipe Event.
286 #define ARM_USBH_SignalEndpointEvent_t ARM_USBH_SignalPipeEvent_t /* Legacy name */
290 \brief USB Host Driver Capabilities.
292 typedef struct _ARM_USBH_CAPABILITIES {
293 uint32_t port_mask : 15; ///< Root HUB available Ports Mask
294 uint32_t auto_split : 1; ///< Automatic SPLIT packet handling
295 uint32_t event_connect : 1; ///< Signal Connect event
296 uint32_t event_disconnect : 1; ///< Signal Disconnect event
297 uint32_t event_overcurrent : 1; ///< Signal Overcurrent event
298 uint32_t reserved : 13; ///< Reserved (must be zero)
299 } ARM_USBH_CAPABILITIES;
303 \brief Access structure of USB Host Driver.
305 typedef struct _ARM_DRIVER_USBH {
306 ARM_DRIVER_VERSION (*GetVersion) (void); ///< Pointer to \ref ARM_USBH_GetVersion : Get driver version.
307 ARM_USBH_CAPABILITIES (*GetCapabilities) (void); ///< Pointer to \ref ARM_USBH_GetCapabilities : Get driver capabilities.
308 int32_t (*Initialize) (ARM_USBH_SignalPortEvent_t cb_port_event,
309 ARM_USBH_SignalPipeEvent_t cb_pipe_event); ///< Pointer to \ref ARM_USBH_Initialize : Initialize USB Host Interface.
310 int32_t (*Uninitialize) (void); ///< Pointer to \ref ARM_USBH_Uninitialize : De-initialize USB Host Interface.
311 int32_t (*PowerControl) (ARM_POWER_STATE state); ///< Pointer to \ref ARM_USBH_PowerControl : Control USB Host Interface Power.
312 int32_t (*PortVbusOnOff) (uint8_t port, bool vbus); ///< Pointer to \ref ARM_USBH_PortVbusOnOff : Root HUB Port VBUS on/off.
313 int32_t (*PortReset) (uint8_t port); ///< Pointer to \ref ARM_USBH_PortReset : Do Root HUB Port Reset.
314 int32_t (*PortSuspend) (uint8_t port); ///< Pointer to \ref ARM_USBH_PortSuspend : Suspend Root HUB Port (stop generating SOFs).
315 int32_t (*PortResume) (uint8_t port); ///< Pointer to \ref ARM_USBH_PortResume : Resume Root HUB Port (start generating SOFs).
316 ARM_USBH_PORT_STATE (*PortGetState) (uint8_t port); ///< Pointer to \ref ARM_USBH_PortGetState : Get current Root HUB Port State.
317 ARM_USBH_PIPE_HANDLE (*PipeCreate) (uint8_t dev_addr,
323 uint16_t ep_max_packet_size,
324 uint8_t ep_interval); ///< Pointer to \ref ARM_USBH_PipeCreate : Create Pipe in System.
325 int32_t (*PipeModify) (ARM_USBH_PIPE_HANDLE pipe_hndl,
330 uint16_t ep_max_packet_size); ///< Pointer to \ref ARM_USBH_PipeModify : Modify Pipe in System.
331 int32_t (*PipeDelete) (ARM_USBH_PIPE_HANDLE pipe_hndl); ///< Pointer to \ref ARM_USBH_PipeDelete : Delete Pipe from System.
332 int32_t (*PipeReset) (ARM_USBH_PIPE_HANDLE pipe_hndl); ///< Pointer to \ref ARM_USBH_PipeReset : Reset Pipe.
333 int32_t (*PipeTransfer) (ARM_USBH_PIPE_HANDLE pipe_hndl,
336 uint32_t num); ///< Pointer to \ref ARM_USBH_PipeTransfer : Transfer packets through USB Pipe.
337 uint32_t (*PipeTransferGetResult) (ARM_USBH_PIPE_HANDLE pipe_hndl); ///< Pointer to \ref ARM_USBH_PipeTransferGetResult : Get result of USB Pipe transfer.
338 int32_t (*PipeTransferAbort) (ARM_USBH_PIPE_HANDLE pipe_hndl); ///< Pointer to \ref ARM_USBH_PipeTransferAbort : Abort current USB Pipe transfer.
339 uint16_t (*GetFrameNumber) (void); ///< Pointer to \ref ARM_USBH_GetFrameNumber : Get current USB Frame Number.
340 } const ARM_DRIVER_USBH;
345 // Function documentation
347 \fn ARM_DRIVER_VERSION ARM_USBH_HCI_GetVersion (void)
348 \brief Get USB Host HCI (OHCI/EHCI) driver version.
349 \return \ref ARM_DRIVER_VERSION
352 \fn ARM_USBH_HCI_CAPABILITIES ARM_USBH_HCI_GetCapabilities (void)
353 \brief Get driver capabilities.
354 \return \ref ARM_USBH_HCI_CAPABILITIES
357 \fn int32_t ARM_USBH_HCI_Initialize (ARM_USBH_HCI_Interrupt_t *cb_interrupt)
358 \brief Initialize USB Host HCI (OHCI/EHCI) Interface.
359 \param[in] cb_interrupt Pointer to Interrupt Handler Routine
360 \return \ref execution_status
363 \fn int32_t ARM_USBH_HCI_Uninitialize (void)
364 \brief De-initialize USB Host HCI (OHCI/EHCI) Interface.
365 \return \ref execution_status
368 \fn int32_t ARM_USBH_HCI_PowerControl (ARM_POWER_STATE state)
369 \brief Control USB Host HCI (OHCI/EHCI) Interface Power.
370 \param[in] state Power state
371 \return \ref execution_status
374 \fn int32_t ARM_USBH_HCI_PortVbusOnOff (uint8_t port, bool vbus)
375 \brief USB Host HCI (OHCI/EHCI) Root HUB Port VBUS on/off.
376 \param[in] port Root HUB Port Number
380 \return \ref execution_status
384 \fn void ARM_USBH_HCI_Interrupt (void)
385 \brief USB Host HCI Interrupt Handler.
389 typedef void (*ARM_USBH_HCI_Interrupt_t) (void); ///< Pointer to Interrupt Handler Routine.
393 \brief USB Host HCI (OHCI/EHCI) Driver Capabilities.
395 typedef struct _ARM_USBH_HCI_CAPABILITIES {
396 uint32_t port_mask : 15; ///< Root HUB available Ports Mask
397 uint32_t reserved : 17; ///< Reserved (must be zero)
398 } ARM_USBH_HCI_CAPABILITIES;
402 \brief Access structure of USB Host HCI (OHCI/EHCI) Driver.
404 typedef struct _ARM_DRIVER_USBH_HCI {
405 ARM_DRIVER_VERSION (*GetVersion) (void); ///< Pointer to \ref ARM_USBH_HCI_GetVersion : Get USB Host HCI (OHCI/EHCI) driver version.
406 ARM_USBH_HCI_CAPABILITIES (*GetCapabilities) (void); ///< Pointer to \ref ARM_USBH_HCI_GetCapabilities : Get driver capabilities.
407 int32_t (*Initialize) (ARM_USBH_HCI_Interrupt_t cb_interrupt); ///< Pointer to \ref ARM_USBH_HCI_Initialize : Initialize USB Host HCI (OHCI/EHCI) Interface.
408 int32_t (*Uninitialize) (void); ///< Pointer to \ref ARM_USBH_HCI_Uninitialize : De-initialize USB Host HCI (OHCI/EHCI) Interface.
409 int32_t (*PowerControl) (ARM_POWER_STATE state); ///< Pointer to \ref ARM_USBH_HCI_PowerControl : Control USB Host HCI (OHCI/EHCI) Interface Power.
410 int32_t (*PortVbusOnOff) (uint8_t port, bool vbus); ///< Pointer to \ref ARM_USBH_HCI_PortVbusOnOff : USB Host HCI (OHCI/EHCI) Root HUB Port VBUS on/off.
411 } const ARM_DRIVER_USBH_HCI;
413 #endif /* __DOXYGEN_MW__ */
419 #endif /* DRIVER_USBH_H_ */