usbhs_otg.h

Go to the documentation of this file.

/*
 * Support and FAQ: visit <a href="https://www.microchip.com/support/">Microchip Support</a>
 */

#ifndef USBHS_OTG_H_INCLUDED
#define USBHS_OTG_H_INCLUDED

#include "compiler.h"

#ifdef __cplusplus
extern "C" {
#endif

/* Get USB VBus/ID pin configuration in board configuration */
#include "conf_board.h"
#include "board.h"
#include "ioport.h"
#include "pio.h"
#include "pio_handler.h"

__always_inline static void otg_io_pin_init(uint32_t pin, uint32_t flags,
    IRQn_Type port_irqn, uint8_t irq_level,
    void (*handler)(uint32_t,uint32_t), uint32_t wkup)
{
        // IOPORT must be initialized before by ioport_init(), \see ioport_group.
        pio_handler_set_pin(pin, flags, handler);
        ioport_set_pin_sense_mode(pin, IOPORT_SENSE_BOTHEDGES);
        NVIC_SetPriority(port_irqn, irq_level);
        NVIC_EnableIRQ(port_irqn);
        pio_enable_pin_interrupt(pin);
        if (wkup) {
                pmc_set_fast_startup_input(wkup);
        }
}


#ifndef USB_INT_LEVEL
# define USB_INT_LEVEL 5
#endif

bool otg_dual_enable(void);

void otg_dual_disable(void);


#define OTG_ID_DETECT       (defined(CONF_BOARD_USB_PORT) && \
    defined(CONF_BOARD_USB_ID_DETECT))
#define OTG_ID_IO           (defined(USB_ID_PIN) && OTG_ID_DETECT)

#if OTG_ID_IO
#define otg_id_init(handler)         otg_io_pin_init(USB_ID_PIN, USB_ID_FLAGS, \
                        USB_ID_PIN_IRQn, USB_INT_LEVEL, handler, false)
# define otg_id_interrupt_enable()   pio_enable_pin_interrupt(USB_ID_PIN)
# define otg_id_interrupt_disable()  pio_disable_pin_interrupt(USB_ID_PIN)
# define Is_otg_id_device()          ioport_get_pin_level(USB_ID_PIN)
# define Is_otg_id_host()            (!Is_otg_id_device())
#endif

#define otg_force_device_mode()             (Set_bits(USBHS->USBHS_CTRL, USBHS_CTRL_UIMOD))
#define Is_otg_device_mode_forced()         (Tst_bits(USBHS->USBHS_CTRL, USBHS_CTRL_UIMOD))
#define otg_force_host_mode()               (Clr_bits(USBHS->USBHS_CTRL, USBHS_CTRL_UIMOD))
#define Is_otg_host_mode_forced()           (!Tst_bits(USBHS->USBHS_CTRL, USBHS_CTRL_UIMOD))


#define OTG_VBUS_DETECT (defined(CONF_BOARD_USB_PORT) && \
    defined(CONF_BOARD_USB_VBUS_DETECT))
#define OTG_VBUS_IO     (defined(USB_VBUS_PIN) && OTG_VBUS_DETECT)
#ifndef USB_VBUS_WKUP
#  define USB_VBUS_WKUP 0
#endif

#define otg_vbus_init(handler)       otg_io_pin_init(USB_VBUS_PIN, USB_VBUS_FLAGS, \
  USB_VBUS_PIN_IRQn, USB_INT_LEVEL, handler, USB_VBUS_WKUP)
#define Is_otg_vbus_high()           ioport_get_pin_level(USB_VBUS_PIN)
#define Is_otg_vbus_low()            (!Is_otg_vbus_high())
#define otg_enable_vbus_interrupt()  pio_enable_pin_interrupt(USB_VBUS_PIN)
#define otg_disable_vbus_interrupt() pio_disable_pin_interrupt(USB_VBUS_PIN)

#define otg_reset()                         \
        do {                                    \
                USBHS->USBHS_CTRL = 0;            \
                while( USBHS->USBHS_SR & 0x3FFF) {\
                        USBHS->USBHS_SCR = 0xFFFFFFFF;\
                }                                   \
        } while (0)
#define otg_enable()                        (Set_bits(USBHS->USBHS_CTRL, USBHS_CTRL_USBE))
#define otg_disable()                       (Clr_bits(USBHS->USBHS_CTRL, USBHS_CTRL_USBE))
#define Is_otg_enabled()                    (Tst_bits(USBHS->USBHS_CTRL, USBHS_CTRL_USBE))

#define Is_otg_clock_usable()               (Tst_bits(USBHS->USBHS_SR, USBHS_SR_CLKUSABLE))

#define otg_freeze_clock()                  (Set_bits(USBHS->USBHS_CTRL, USBHS_CTRL_FRZCLK))
#define otg_unfreeze_clock()                (Clr_bits(USBHS->USBHS_CTRL, USBHS_CTRL_FRZCLK))
#define Is_otg_clock_frozen()               (Tst_bits(USBHS->USBHS_CTRL, USBHS_CTRL_FRZCLK))

#define otg_enable_rderr_interrupt()          (Set_bits(USBHS->USBHS_CTRL, USBHS_CTRL_RDERRE))
#define otg_disable_rderr_interrupt()         (Clr_bits(USBHS->USBHS_CTRL, USBHS_CTRL_RDERRE))
#define Is_otg_rderr_interrupt_enabled()      (Tst_bits(USBHS->USBHS_CTRL, USBHS_CTRL_RDERRE))
#define otg_ack_rderr_interrupt()             (USBHS->USBHS_SCR = USBHS_SCR_RDERRIC)
#define otg_raise_rderr_interrupt()           (USBHS->USBHS_SFR = USBHS_SFR_RDERRIS)
#define Is_otg_rderr_interrupt()              (Tst_bits(USBHS->USBHS_SR, USBHS_SR_RDERRI))


#ifdef __cplusplus
}
#endif


#endif /* USBHS_OTG_H_INCLUDED */