apidoc/latest/usbd__uac2_8h_source.html

/*

 * Copyright (c) 2023-2024 Nordic Semiconductor ASA

 *

 * SPDX-License-Identifier: Apache-2.0

 */


#ifndef ZEPHYR_INCLUDE_USB_CLASS_USBD_UAC2_H_

#define ZEPHYR_INCLUDE_USB_CLASS_USBD_UAC2_H_


#include <zephyr/device.h>


#define UAC2_ENTITY_ID(node)                                                    \

        ({                                                                      \

                BUILD_ASSERT(DT_NODE_HAS_COMPAT(DT_PARENT(node), zephyr_uac2)); \

                UTIL_INC(DT_NODE_CHILD_IDX(node));                              \

        })


struct uac2_ops {

        void (*sof_cb)(const struct device *dev, void *user_data);

        void (*terminal_update_cb)(const struct device *dev, uint8_t terminal,

                                   bool enabled, bool microframes,

                                   void *user_data);

        void *(*get_recv_buf)(const struct device *dev, uint8_t terminal,

                              uint16_t size, void *user_data);

        void (*data_recv_cb)(const struct device *dev, uint8_t terminal,

                             void *buf, uint16_t size, void *user_data);

        void (*buf_release_cb)(const struct device *dev, uint8_t terminal,

                               void *buf, void *user_data);

        uint32_t (*feedback_cb)(const struct device *dev, uint8_t terminal,

                                void *user_data);

        uint32_t (*get_sample_rate)(const struct device *dev, uint8_t clock_id,

                                    void *user_data);

        int (*set_sample_rate)(const struct device *dev, uint8_t clock_id,

                               uint32_t rate, void *user_data);

};


void usbd_uac2_set_ops(const struct device *dev,

                       const struct uac2_ops *ops, void *user_data);


int usbd_uac2_send(const struct device *dev, uint8_t terminal,

                   void *data, uint16_t size);


#endif /* ZEPHYR_INCLUDE_USB_CLASS_USBD_UAC2_H_ */

device.h

usbd_uac2_set_ops
void usbd_uac2_set_ops(const struct device *dev, const struct uac2_ops *ops, void *user_data)
Register USB Audio 2 application callbacks.

usbd_uac2_send
int usbd_uac2_send(const struct device *dev, uint8_t terminal, void *data, uint16_t size)
Send audio data to output terminal.

uint32_t
__UINT32_TYPE__ uint32_t
Definition stdint.h:90

uint8_t
__UINT8_TYPE__ uint8_t
Definition stdint.h:88

uint16_t
__UINT16_TYPE__ uint16_t
Definition stdint.h:89

device
Runtime device structure (in ROM) per driver instance.
Definition device.h:412

device::data
void * data
Address of the device instance private data.
Definition device.h:422

uac2_ops
USB Audio 2 application event handlers.
Definition usbd_uac2.h:45

uac2_ops::sof_cb
void(* sof_cb)(const struct device *dev, void *user_data)
Start of Frame callback.
Definition usbd_uac2.h:54

uac2_ops::buf_release_cb
void(* buf_release_cb)(const struct device *dev, uint8_t terminal, void *buf, void *user_data)
Transmit buffer release callback.
Definition usbd_uac2.h:109

uac2_ops::set_sample_rate
int(* set_sample_rate)(const struct device *dev, uint8_t clock_id, uint32_t rate, void *user_data)
Set active sample rate.
Definition usbd_uac2.h:159

uac2_ops::data_recv_cb
void(* data_recv_cb)(const struct device *dev, uint8_t terminal, void *buf, uint16_t size, void *user_data)
Data received.
Definition usbd_uac2.h:96

uac2_ops::feedback_cb
uint32_t(* feedback_cb)(const struct device *dev, uint8_t terminal, void *user_data)
Get Explicit Feedback value.
Definition usbd_uac2.h:126

uac2_ops::get_sample_rate
uint32_t(* get_sample_rate)(const struct device *dev, uint8_t clock_id, void *user_data)
Get active sample rate.
Definition usbd_uac2.h:142

uac2_ops::terminal_update_cb
void(* terminal_update_cb)(const struct device *dev, uint8_t terminal, bool enabled, bool microframes, void *user_data)
Terminal update callback.
Definition usbd_uac2.h:66