Zephyr API Documentation 4.0.0-rc2
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
uhc.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2022 Nordic Semiconductor ASA
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
12#ifndef ZEPHYR_INCLUDE_UHC_H
13#define ZEPHYR_INCLUDE_UHC_H
14
15#include <zephyr/kernel.h>
16#include <zephyr/device.h>
17#include <zephyr/net_buf.h>
18#include <zephyr/usb/usb_ch9.h>
19#include <zephyr/sys/dlist.h>
20
38
77
106
115struct uhc_event {
120 union {
125 };
127 const struct device *dev;
128};
129
141typedef int (*uhc_event_cb_t)(const struct device *dev,
142 const struct uhc_event *const event);
143
152};
153
157#define UHC_STATUS_INITIALIZED 0
161#define UHC_STATUS_ENABLED 1
162
185
193static inline bool uhc_is_initialized(const struct device *dev)
194{
195 struct uhc_data *data = dev->data;
196
198}
199
207static inline bool uhc_is_enabled(const struct device *dev)
208{
209 struct uhc_data *data = dev->data;
210
212}
213
217struct uhc_api {
218 int (*lock)(const struct device *dev);
219 int (*unlock)(const struct device *dev);
220
221 int (*init)(const struct device *dev);
222 int (*enable)(const struct device *dev);
223 int (*disable)(const struct device *dev);
224 int (*shutdown)(const struct device *dev);
225
226 int (*bus_reset)(const struct device *dev);
227 int (*sof_enable)(const struct device *dev);
228 int (*bus_suspend)(const struct device *dev);
229 int (*bus_resume)(const struct device *dev);
230
231 int (*ep_enqueue)(const struct device *dev,
232 struct uhc_transfer *const xfer);
233 int (*ep_dequeue)(const struct device *dev,
234 struct uhc_transfer *const xfer);
235};
251static inline int uhc_bus_reset(const struct device *dev)
252{
253 const struct uhc_api *api = dev->api;
254 int ret;
255
256 api->lock(dev);
257 ret = api->bus_reset(dev);
258 api->unlock(dev);
259
260 return ret;
261}
262
273static inline int uhc_sof_enable(const struct device *dev)
274{
275 const struct uhc_api *api = dev->api;
276 int ret;
277
278 api->lock(dev);
279 ret = api->sof_enable(dev);
280 api->unlock(dev);
281
282 return ret;
283}
284
296static inline int uhc_bus_suspend(const struct device *dev)
297{
298 const struct uhc_api *api = dev->api;
299 int ret;
300
301 api->lock(dev);
302 ret = api->bus_suspend(dev);
303 api->unlock(dev);
304
305 return ret;
306}
307
319static inline int uhc_bus_resume(const struct device *dev)
320{
321 const struct uhc_api *api = dev->api;
322 int ret;
323
324 api->lock(dev);
325 ret = api->bus_resume(dev);
326 api->unlock(dev);
327
328 return ret;
329}
330
349struct uhc_transfer *uhc_xfer_alloc(const struct device *dev,
350 const uint8_t addr,
351 const uint8_t ep,
352 const uint8_t attrib,
353 const uint16_t mps,
354 const uint16_t timeout,
355 void *const udev,
356 void *const cb);
357
376 const uint8_t addr,
377 const uint8_t ep,
378 const uint8_t attrib,
379 const uint16_t mps,
380 const uint16_t timeout,
381 void *const udev,
382 void *const cb,
383 size_t size);
384
395int uhc_xfer_free(const struct device *dev,
396 struct uhc_transfer *const xfer);
397
409int uhc_xfer_buf_add(const struct device *dev,
410 struct uhc_transfer *const xfer,
411 struct net_buf *buf);
423struct net_buf *uhc_xfer_buf_alloc(const struct device *dev,
424 const size_t size);
425
434void uhc_xfer_buf_free(const struct device *dev, struct net_buf *const buf);
435
448int uhc_ep_enqueue(const struct device *dev, struct uhc_transfer *const xfer);
449
461int uhc_ep_dequeue(const struct device *dev, struct uhc_transfer *const xfer);
462
475int uhc_init(const struct device *dev, uhc_event_cb_t event_cb);
476
489int uhc_enable(const struct device *dev);
490
501int uhc_disable(const struct device *dev);
502
514int uhc_shutdown(const struct device *dev);
515
526static inline struct uhc_device_caps uhc_caps(const struct device *dev)
527{
528 struct uhc_data *data = dev->data;
529
530 return data->caps;
531}
532
537#endif /* ZEPHYR_INCLUDE_UHC_H */
long atomic_t
Definition atomic_types.h:15
static bool atomic_test_bit(const atomic_t *target, int bit)
Atomically get and test a bit.
Definition atomic.h:127
static int shutdown(int sock, int how)
POSIX wrapper for zsock_shutdown.
Definition socket.h:836
struct _dnode sys_dnode_t
Doubly-linked list node structure.
Definition dlist.h:54
struct _dnode sys_dlist_t
Doubly-linked list structure.
Definition dlist.h:50
struct _snode sys_snode_t
Single-linked list node structure.
Definition slist.h:39
#define UHC_STATUS_INITIALIZED
Controller is initialized by uhc_init()
Definition uhc.h:157
static bool uhc_is_enabled(const struct device *dev)
Checks whether the controller is enabled.
Definition uhc.h:207
struct uhc_transfer * uhc_xfer_alloc(const struct device *dev, const uint8_t addr, const uint8_t ep, const uint8_t attrib, const uint16_t mps, const uint16_t timeout, void *const udev, void *const cb)
Allocate UHC transfer.
#define UHC_STATUS_ENABLED
Controller is enabled and all API functions are available.
Definition uhc.h:161
static bool uhc_is_initialized(const struct device *dev)
Checks whether the controller is initialized.
Definition uhc.h:193
int(* uhc_event_cb_t)(const struct device *dev, const struct uhc_event *const event)
Callback to submit UHC event to higher layer.
Definition uhc.h:141
static int uhc_bus_reset(const struct device *dev)
Reset USB bus.
Definition uhc.h:251
struct uhc_transfer * uhc_xfer_alloc_with_buf(const struct device *dev, const uint8_t addr, const uint8_t ep, const uint8_t attrib, const uint16_t mps, const uint16_t timeout, void *const udev, void *const cb, size_t size)
Allocate UHC transfer with buffer.
static int uhc_bus_resume(const struct device *dev)
Resume USB bus.
Definition uhc.h:319
int uhc_xfer_buf_add(const struct device *dev, struct uhc_transfer *const xfer, struct net_buf *buf)
Add UHC transfer buffer.
int uhc_ep_enqueue(const struct device *dev, struct uhc_transfer *const xfer)
Queue USB host controller transfer.
int uhc_ep_dequeue(const struct device *dev, struct uhc_transfer *const xfer)
Remove a USB host controller transfers from queue.
static struct uhc_device_caps uhc_caps(const struct device *dev)
Get USB host controller capabilities.
Definition uhc.h:526
static int uhc_bus_suspend(const struct device *dev)
Suspend USB bus.
Definition uhc.h:296
int uhc_disable(const struct device *dev)
Disable USB host controller.
int uhc_xfer_free(const struct device *dev, struct uhc_transfer *const xfer)
Free UHC transfer and any buffers.
struct net_buf * uhc_xfer_buf_alloc(const struct device *dev, const size_t size)
Allocate UHC transfer buffer.
uhc_event_type
USB host controller event types.
Definition uhc.h:81
int uhc_init(const struct device *dev, uhc_event_cb_t event_cb)
Initialize USB host controller.
void uhc_xfer_buf_free(const struct device *dev, struct net_buf *const buf)
Free UHC request buffer.
int uhc_shutdown(const struct device *dev)
Poweroff USB host controller.
uhc_control_stage
USB control transfer stage.
Definition uhc.h:33
static int uhc_sof_enable(const struct device *dev)
Enable Start of Frame generator.
Definition uhc.h:273
int uhc_enable(const struct device *dev)
Enable USB host controller.
@ UHC_EVT_EP_REQUEST
Endpoint request result event.
Definition uhc.h:99
@ UHC_EVT_DEV_CONNECTED_HS
High speed device connected.
Definition uhc.h:87
@ UHC_EVT_DEV_CONNECTED_FS
Full speed device connected.
Definition uhc.h:85
@ UHC_EVT_RWUP
Remote wakeup signal.
Definition uhc.h:97
@ UHC_EVT_SUSPENDED
Bus suspend operation finished.
Definition uhc.h:93
@ UHC_EVT_DEV_REMOVED
Device (peripheral) removed.
Definition uhc.h:89
@ UHC_EVT_RESUMED
Bus resume operation finished.
Definition uhc.h:95
@ UHC_EVT_DEV_CONNECTED_LS
Low speed device connected.
Definition uhc.h:83
@ UHC_EVT_ERROR
Non-correctable error event, requires attention from higher levels or application.
Definition uhc.h:104
@ UHC_EVT_RESETED
Bus reset operation finished.
Definition uhc.h:91
@ UHC_CONTROL_STAGE_DATA
Definition uhc.h:35
@ UHC_CONTROL_STAGE_SETUP
Definition uhc.h:34
@ UHC_CONTROL_STAGE_STATUS
Definition uhc.h:36
Public kernel APIs.
Buffer management.
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__UINT16_TYPE__ uint16_t
Definition stdint.h:89
Runtime device structure (in ROM) per driver instance.
Definition device.h:412
void * data
Address of the device instance private data.
Definition device.h:422
const void * api
Address of the API structure exposed by the device instance.
Definition device.h:418
Mutex Structure.
Definition kernel.h:2994
Network buffer representation.
Definition net_buf.h:1006
uint16_t size
Amount of data that this buffer can store.
Definition net_buf.h:1038
Common UHC driver data structure.
Definition uhc.h:169
struct k_mutex mutex
Driver access mutex.
Definition uhc.h:173
atomic_t status
USB host controller status.
Definition uhc.h:181
void * priv
Driver private data.
Definition uhc.h:183
sys_dlist_t ctrl_xfers
dlist for control transfers
Definition uhc.h:175
struct uhc_device_caps caps
Controller capabilities.
Definition uhc.h:171
sys_dlist_t bulk_xfers
dlist for bulk transfers
Definition uhc.h:177
uhc_event_cb_t event_cb
Callback to submit an UHC event to upper layer.
Definition uhc.h:179
USB host controller capabilities.
Definition uhc.h:149
uint32_t hs
USB high speed capable controller.
Definition uhc.h:151
USB host controller event.
Definition uhc.h:115
struct uhc_transfer * xfer
Pointer to request used only for UHC_EVT_EP_REQUEST.
Definition uhc.h:124
const struct device * dev
Pointer to controller's device struct.
Definition uhc.h:127
enum uhc_event_type type
Event type.
Definition uhc.h:119
int status
Event status value, if any.
Definition uhc.h:122
sys_snode_t node
slist node for the message queue
Definition uhc.h:117
UHC endpoint buffer info.
Definition uhc.h:49
void * udev
Pointer to USB device (opaque for the UHC)
Definition uhc.h:71
int err
Transfer result, 0 on success, other values on error.
Definition uhc.h:75
struct net_buf * buf
Transfer data buffer.
Definition uhc.h:55
uint8_t addr
Device (peripheral) address.
Definition uhc.h:57
uint16_t mps
Maximum packet size.
Definition uhc.h:63
uint16_t timeout
Timeout in number of frames.
Definition uhc.h:65
unsigned int stage
Control stage status, up to the driver to use it or not.
Definition uhc.h:69
uint8_t ep
Endpoint to which request is associated.
Definition uhc.h:59
unsigned int queued
Flag marks request buffer is queued.
Definition uhc.h:67
void * cb
Pointer to transfer completion callback (opaque for the UHC)
Definition uhc.h:73
uint8_t attrib
Endpoint attributes (TBD)
Definition uhc.h:61
sys_dnode_t node
dlist node
Definition uhc.h:51
uint8_t setup_pkt[8]
Control transfer setup packet.
Definition uhc.h:53
USB Chapter 9 structures and definitions.