usbh.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_USBH_H_
#define ZEPHYR_INCLUDE_USBH_H_
 
#include <stdint.h>
#include <zephyr/device.h>
#include <zephyr/net/buf.h>
#include <zephyr/sys/dlist.h>
#include <zephyr/drivers/usb/uhc.h>
#include <zephyr/sys/iterable_sections.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct usbh_contex {
        const char *name;
        struct k_mutex mutex;
        const struct device *dev;
        sys_dlist_t peripherals;
};
 
#define USBH_CONTROLLER_DEFINE(device_name, uhc_dev)                    \
        static STRUCT_SECTION_ITERABLE(usbh_contex, device_name) = {    \
                .name = STRINGIFY(device_name),                         \
                .mutex = Z_MUTEX_INITIALIZER(device_name.mutex),        \
                .dev = uhc_dev,                                         \
        }
 
struct usbh_peripheral {
        sys_dnode_t node;
        uint8_t addr;
        uint8_t speed;
};
 
struct usbh_class_code {
        uint8_t dclass;
        uint8_t sub;
        uint8_t proto;
        uint8_t reserved;
};
 
struct usbh_class_data {
        struct usbh_class_code code;
 
        /* int (*init)(struct usbh_contex *const uhs_ctx); */
        int (*request)(struct usbh_contex *const uhs_ctx,
                        struct uhc_transfer *const xfer, int err);
        int (*connected)(struct usbh_contex *const uhs_ctx);
        int (*removed)(struct usbh_contex *const uhs_ctx);
        int (*rwup)(struct usbh_contex *const uhs_ctx);
        int (*suspended)(struct usbh_contex *const uhs_ctx);
        int (*resumed)(struct usbh_contex *const uhs_ctx);
};
 
#define USBH_DEFINE_CLASS(name) \
        static STRUCT_SECTION_ITERABLE(usbh_class_data, name)
 
 
int usbh_init(struct usbh_contex *uhs_ctx);
 
int usbh_enable(struct usbh_contex *uhs_ctx);
 
int usbh_disable(struct usbh_contex *uhs_ctx);
 
int usbh_shutdown(struct usbh_contex *const uhs_ctx);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_USBH_H_ */