uhc.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_UHC_H
#define ZEPHYR_INCLUDE_UHC_H
 
#include <zephyr/kernel.h>
#include <zephyr/device.h>
#include <zephyr/net/buf.h>
#include <zephyr/usb/usb_ch9.h>
#include <zephyr/sys/dlist.h>
 
struct uhc_transfer {
        sys_dnode_t node;
        struct k_fifo queue;
        struct k_fifo done;
        uint8_t addr;
        uint8_t ep;
        uint8_t attrib;
        uint16_t mps;
        uint16_t timeout;
        unsigned int claimed : 1;
        unsigned int queued : 1;
        unsigned int setup : 1;
        void *owner;
};
 
enum uhc_event_type {
        UHC_EVT_DEV_CONNECTED_LS,
        UHC_EVT_DEV_CONNECTED_FS,
        UHC_EVT_DEV_CONNECTED_HS,
        UHC_EVT_DEV_REMOVED,
        UHC_EVT_RESETED,
        UHC_EVT_SUSPENDED,
        UHC_EVT_RESUMED,
        UHC_EVT_RWUP,
        UHC_EVT_EP_REQUEST,
        UHC_EVT_ERROR,
};
 
struct uhc_event {
        sys_snode_t node;
        enum uhc_event_type type;
        union {
                uint32_t value;
                struct uhc_transfer *xfer;
        };
        int status;
        const struct device *dev;
};
 
typedef int (*uhc_event_cb_t)(const struct device *dev,
                              const struct uhc_event *const event);
 
struct uhc_device_caps {
        uint32_t hs : 1;
};
 
#define UHC_STATUS_INITIALIZED          0
#define UHC_STATUS_ENABLED              1
 
struct uhc_data {
        struct uhc_device_caps caps;
        struct k_mutex mutex;
        sys_dlist_t ctrl_xfers;
        sys_dlist_t bulk_xfers;
        uhc_event_cb_t event_cb;
        atomic_t status;
        void *priv;
};
 
static inline bool uhc_is_initialized(const struct device *dev)
{
        struct uhc_data *data = dev->data;
 
        return atomic_test_bit(&data->status, UHC_STATUS_INITIALIZED);
}
 
static inline bool uhc_is_enabled(const struct device *dev)
{
        struct uhc_data *data = dev->data;
 
        return atomic_test_bit(&data->status, UHC_STATUS_ENABLED);
}
 
struct uhc_api {
        int (*lock)(const struct device *dev);
        int (*unlock)(const struct device *dev);
 
        int (*init)(const struct device *dev);
        int (*enable)(const struct device *dev);
        int (*disable)(const struct device *dev);
        int (*shutdown)(const struct device *dev);
 
        int (*bus_reset)(const struct device *dev);
        int (*sof_enable)(const struct device *dev);
        int (*bus_suspend)(const struct device *dev);
        int (*bus_resume)(const struct device *dev);
 
        int (*ep_enqueue)(const struct device *dev,
                          struct uhc_transfer *const xfer);
        int (*ep_dequeue)(const struct device *dev,
                          struct uhc_transfer *const xfer);
};
static inline int uhc_bus_reset(const struct device *dev)
{
        const struct uhc_api *api = dev->api;
        int ret;
 
        api->lock(dev);
        ret = api->bus_reset(dev);
        api->unlock(dev);
 
        return ret;
}
 
static inline int uhc_sof_enable(const struct device *dev)
{
        const struct uhc_api *api = dev->api;
        int ret;
 
        api->lock(dev);
        ret = api->sof_enable(dev);
        api->unlock(dev);
 
        return ret;
}
 
static inline int uhc_bus_suspend(const struct device *dev)
{
        const struct uhc_api *api = dev->api;
        int ret;
 
        api->lock(dev);
        ret = api->bus_suspend(dev);
        api->unlock(dev);
 
        return ret;
}
 
static inline int uhc_bus_resume(const struct device *dev)
{
        const struct uhc_api *api = dev->api;
        int ret;
 
        api->lock(dev);
        ret = api->bus_resume(dev);
        api->unlock(dev);
 
        return ret;
}
 
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 owner);
 
int uhc_xfer_free(const struct device *dev,
                  struct uhc_transfer *const xfer);
 
struct net_buf *uhc_xfer_buf_alloc(const struct device *dev,
                                   struct uhc_transfer *const xfer,
                                   const size_t size);
 
int uhc_xfer_buf_free(const struct device *dev, struct net_buf *const buf);
 
int uhc_ep_enqueue(const struct device *dev, struct uhc_transfer *const xfer);
 
int uhc_ep_dequeue(const struct device *dev, struct uhc_transfer *const xfer);
 
int uhc_init(const struct device *dev, uhc_event_cb_t event_cb);
 
int uhc_enable(const struct device *dev);
 
int uhc_disable(const struct device *dev);
 
int uhc_shutdown(const struct device *dev);
 
static inline struct uhc_device_caps uhc_caps(const struct device *dev)
{
        struct uhc_data *data = dev->data;
 
        return data->caps;
}
 
#endif /* ZEPHYR_INCLUDE_UHC_H */