uaol.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Intel Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_DRIVERS_UAOL_H_
#define ZEPHYR_INCLUDE_DRIVERS_UAOL_H_
 
#include <stdint.h>
#include <zephyr/device.h>

struct uaol_capabilities {
        uint32_t input_streams;          
        uint32_t output_streams;         
        uint32_t bidirectional_streams;  
        uint32_t max_tx_fifo_size;       
        uint32_t max_rx_fifo_size;       
};

enum uaol_direction {
        UAOL_DIR_PLAYBACK = 0, 
        UAOL_DIR_CAPTURE  = 1, 
};

struct uaol_config {
        uint8_t xhci_bus;                
        uint8_t xhci_device;             
        uint8_t xhci_function;           
        uint16_t art_divider_m;          
        uint16_t art_divider_n;          
        uint32_t sample_rate;            
        uint32_t channels;               
        uint32_t sample_bits;            
        uint32_t service_interval;       
        uint32_t sio_credit_size;        
        uint16_t fifo_start_offset;      
        uint16_t channel_map;            
        enum uaol_direction direction;   
};

struct uaol_ep_table_entry {
        uint32_t usb_ep_address     : 5;  
        uint32_t device_slot_number : 8;  
        uint32_t split_ep           : 1;  
};

typedef int (*uaol_api_config)(const struct device *dev, int stream, struct uaol_config *config);
 
typedef int (*uaol_api_start)(const struct device *dev, int stream);
 
typedef int (*uaol_api_stop)(const struct device *dev, int stream);
 
typedef int (*uaol_api_program_ep_table)(const struct device *dev, int stream,
                                         struct uaol_ep_table_entry entry, bool valid);
 
typedef int (*uaol_api_get_capabilities)(const struct device *dev, struct uaol_capabilities *caps);
 
__subsystem struct uaol_driver_api {
        uaol_api_config config;
        uaol_api_start start;
        uaol_api_stop stop;
        uaol_api_program_ep_table program_ep_table;
        uaol_api_get_capabilities get_capabilities;
};

static inline int uaol_config(const struct device *dev, int stream, struct uaol_config *cfg)
{
        return DEVICE_API_GET(uaol, dev)->config(dev, stream, cfg);
}

static inline int uaol_start(const struct device *dev, int stream)
{
        return DEVICE_API_GET(uaol, dev)->start(dev, stream);
}

static inline int uaol_stop(const struct device *dev, int stream)
{
        return DEVICE_API_GET(uaol, dev)->stop(dev, stream);
}

static inline int uaol_program_ep_table(const struct device *dev, int stream,
                                        struct uaol_ep_table_entry entry, bool valid)
{
        return DEVICE_API_GET(uaol, dev)->program_ep_table(dev, stream, entry, valid);
}

static inline int uaol_get_capabilities(const struct device *dev, struct uaol_capabilities *caps)
{
        return DEVICE_API_GET(uaol, dev)->get_capabilities(dev, caps);
}

int uaol_get_mapped_hda_link_stream_id(const struct device *dev, int uaol_stream_id);
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_UAOL_H_ */