forked from mfulz_github/qmk_firmware
Minor documentation improvements.
This commit is contained in:
parent
0598d622d8
commit
7750783809
|
@ -124,13 +124,13 @@
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#if !defined(CONTROL_ONLY_DEVICE) || defined(__DOXYGEN__)
|
#if !defined(CONTROL_ONLY_DEVICE) || defined(__DOXYGEN__)
|
||||||
#if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)
|
#if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || defined(__DOXYGEN__)
|
||||||
#define ENDPOINT_TOTAL_ENDPOINTS 7
|
|
||||||
#else
|
|
||||||
/** Total number of endpoints (including the default control endpoint at address 0) which may
|
/** Total number of endpoints (including the default control endpoint at address 0) which may
|
||||||
* be used in the device. Different USB AVR models support different amounts of endpoints,
|
* be used in the device. Different USB AVR models support different amounts of endpoints,
|
||||||
* this value reflects the maximum number of endpoints for the currently selected AVR model.
|
* this value reflects the maximum number of endpoints for the currently selected AVR model.
|
||||||
*/
|
*/
|
||||||
|
#define ENDPOINT_TOTAL_ENDPOINTS 7
|
||||||
|
#else
|
||||||
#define ENDPOINT_TOTAL_ENDPOINTS 5
|
#define ENDPOINT_TOTAL_ENDPOINTS 5
|
||||||
#endif
|
#endif
|
||||||
#else
|
#else
|
||||||
|
|
|
@ -105,7 +105,7 @@
|
||||||
{
|
{
|
||||||
uint8_t Address; /**< Address of the pipe to configure, or zero if the table entry is to be unused. */
|
uint8_t Address; /**< Address of the pipe to configure, or zero if the table entry is to be unused. */
|
||||||
uint16_t Size; /**< Size of the pipe bank, in bytes. */
|
uint16_t Size; /**< Size of the pipe bank, in bytes. */
|
||||||
uint8_t EndpointAddress; /** Address of the endpoint in the connected device. */
|
uint8_t EndpointAddress; /**< Address of the endpoint in the connected device. */
|
||||||
uint8_t Type; /**< Type of the endpoint, a \c EP_TYPE_* mask. */
|
uint8_t Type; /**< Type of the endpoint, a \c EP_TYPE_* mask. */
|
||||||
uint8_t Banks; /**< Number of hardware banks to use for the pipe. */
|
uint8_t Banks; /**< Number of hardware banks to use for the pipe. */
|
||||||
} USB_Pipe_Table_t;
|
} USB_Pipe_Table_t;
|
||||||
|
|
|
@ -43,17 +43,11 @@ ISR(Unhandled_Interrupt)
|
||||||
for (;;);
|
for (;;);
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Retrieves the associated interrupt handler for the interrupt group currently being fired. This
|
|
||||||
* is called directly from the exception handler routine before dispatching to the ISR.
|
|
||||||
*/
|
|
||||||
InterruptHandlerPtr_t INTC_GetInterruptHandler(const uint_reg_t InterruptLevel)
|
InterruptHandlerPtr_t INTC_GetInterruptHandler(const uint_reg_t InterruptLevel)
|
||||||
{
|
{
|
||||||
return InterruptHandlers[AVR32_INTC.icr[AVR32_INTC_INT3 - InterruptLevel]];
|
return InterruptHandlers[AVR32_INTC.icr[AVR32_INTC_INT3 - InterruptLevel]];
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Initializes the interrupt controller ready to handle interrupts. This must be called at the
|
|
||||||
* start of the user program before any interrupts are registered or enabled.
|
|
||||||
*/
|
|
||||||
void INTC_Init(void)
|
void INTC_Init(void)
|
||||||
{
|
{
|
||||||
for (uint8_t InterruptGroup = 0; InterruptGroup < AVR32_INTC_NUM_INT_GRPS; InterruptGroup++)
|
for (uint8_t InterruptGroup = 0; InterruptGroup < AVR32_INTC_NUM_INT_GRPS; InterruptGroup++)
|
||||||
|
|
|
@ -110,7 +110,18 @@
|
||||||
#define INTC_IRQ_LINE(IRQIndex) (IRQIndex % 32)
|
#define INTC_IRQ_LINE(IRQIndex) (IRQIndex % 32)
|
||||||
|
|
||||||
/* Function Prototypes: */
|
/* Function Prototypes: */
|
||||||
|
/** Initializes the interrupt controller ready to handle interrupts. This must be called at the
|
||||||
|
* start of the user program before any interrupts are registered or enabled.
|
||||||
|
*/
|
||||||
void INTC_Init(void);
|
void INTC_Init(void);
|
||||||
|
|
||||||
|
/** Retrieves the associated interrupt handler for the interrupt group currently being fired. This
|
||||||
|
* is called directly from the exception handler routine before dispatching to the ISR.
|
||||||
|
*
|
||||||
|
* \param[in] InterruptLevel Priority level of the interrupt.
|
||||||
|
*
|
||||||
|
* \return Pointer to the associated interrupt handler function, or NULL if no handler set.
|
||||||
|
*/
|
||||||
InterruptHandlerPtr_t INTC_GetInterruptHandler(const uint_reg_t InterruptLevel);
|
InterruptHandlerPtr_t INTC_GetInterruptHandler(const uint_reg_t InterruptLevel);
|
||||||
|
|
||||||
/* Inline Functions: */
|
/* Inline Functions: */
|
||||||
|
|
Loading…
Reference in New Issue