drivers/usb/usbb_internal.h

Go to the documentation of this file.

#ifndef USBB_INTERNAL_H_INCLUDED
#define USBB_INTERNAL_H_INCLUDED

#include <bitops.h>
#include <dmapool.h>
#include <slist.h>
#include <stdint.h>
#include <usb/request.h>
#include <usb/udc.h>

#include "usbb_regs.h"

struct usbb_sw_dma_desc {
        struct usbb_dma_desc    hw;
        phys_addr_t                     phys;
};

static inline phys_addr_t usbb_dma_desc_phys(struct usbb_sw_dma_desc *desc)
{
        return desc->phys;
};

static inline void usbb_dma_desc_set_phys(struct usbb_sw_dma_desc *desc,
                phys_addr_t phys)
{
        desc->phys = phys;
}

/* USB Device Controller part */

enum ep0_state {
        EP0_STATE_SETUP = 0,    
        EP0_STATE_DATA_IN,      
        EP0_STATE_DATA_ZLP,     
        EP0_STATE_DATA_OUT,     
        EP0_STATE_STATUS_IN,    
        EP0_STATE_STATUS_OUT,   
        EP0_STATE_TEST_J,       
        EP0_STATE_TEST_K,       
        EP0_STATE_TEST_SE0_NAK, 
        EP0_STATE_TEST_PACKET,  
};

enum usbb_ep_flag {
        USBB_EP_ACTIVE_XFER,
        USBB_EP_ENABLED,
        USBB_EP_WEDGE,
};

struct usbb_udc_ep {
        const struct usb_endpoint_descriptor *desc;
        unsigned int            buf_offset;
        uint16_t                maxpacket;
        uint16_t                bytes_written;
        unsigned long           flags;
        struct slist            req_queue;
        struct slist            buf_queue;
};

struct usbb_udc {
        struct udc              udc;
        enum ep0_state          ctrl_state;
        struct usb_setup_req    setup_req;
        struct usbb_controller  *usbb;
        struct usbb_udc_ep      ep[CONFIG_USBB_NR_EP];
};

static inline bool usbb_udc_entering_test_mode(struct usbb_udc *udcb)
{
#ifdef CONFIG_UDC_HIGH_SPEED
        return udcb->ctrl_state >= EP0_STATE_TEST_J
                && udcb->ctrl_state <= EP0_STATE_TEST_PACKET;
#else
        return false;
#endif
}

static inline bool usbb_udc_is_enabled(struct usbb_udc *udcb)
{
#if defined(CONFIG_USBB_OTG)
        return test_bit(USB_DEV_IS_ENABLED, &udcb->udc.flags);
#elif defined(CONFIG_USBB_UDC)
        return true;
#else
        return false;
#endif
}

static inline void usbb_udc_enable(struct usbb_udc *udcb)
{
        /*
         * Keep the autoattach flag as the application left it, set the
         * enabled flag and clear everything else. The USBB core driver
         * will check the Vbus state right after enabling the
         * controller.
         */
        udcb->udc.flags &= (1 << USB_DEV_IS_ENABLED)
                | (1 << USB_DEV_AUTOATTACH);
        udcb->udc.flags |= 1 << USB_DEV_IS_ENABLED;
}

static inline void usbb_udc_disable(struct usbb_udc *udcb)
{
        /*
         * Clear all flags except the autoattach flag set by the
         * application
         */
        udcb->udc.flags &= 1 << USB_DEV_AUTOATTACH;
}

extern void usbb_udc_interrupt(struct usbb_udc *udcb);
extern void usbb_udc_vbus_off(struct usbb_udc *udcb);
extern void usbb_udc_vbus_on(struct usbb_udc *udcb);
extern struct usbb_udc *usbb_udc_init(void);
extern void usbb_udc_shutdown(struct usbb_udc *udcb);

/* USB Host part */

struct usbb_host {

};

static inline bool usbb_host_is_enabled(struct usbb_host *hostb)
{
#if defined(CONFIG_USBB_OTG)
        return test_bit(USB_HOST_IS_ENABLED, &hostb->hcd.flags);
#elif defined(CONFIG_USBB_HOST)
        return true;
#else
        return false;
#endif
}

extern void usbb_host_enable(struct usbb_host *hostb);
extern void usbb_host_disable(struct usbb_host *hostb);
extern struct usbb_host *usbb_host_init(void);
extern void usbb_host_shutdown(struct usbb_host *hostb);

/* USB Master and OTG part */

struct usbb_controller {
#ifdef CONFIG_USBB_UDC
        struct usbb_udc         *udc;
#endif
#ifdef CONFIG_USBB_HOST
        struct usbb_host        *host;
#endif
};

extern struct dma_pool  usbb_desc_pool;

static inline struct usbb_sw_dma_desc *usbb_dma_desc_alloc(phys_addr_t *paddr)
{
        return dma_pool_alloc(&usbb_desc_pool, paddr);
}

static inline void usbb_dma_desc_free(struct usbb_sw_dma_desc *desc)
{
        dma_pool_free(&usbb_desc_pool, desc);
}

#endif /* USBB_INTERNAL_H_INCLUDED */

---