jackcartersmith/blackmagic
1
0
Fork 0
Code Issues Pull Requests Releases Activity

pac55xx: fix up and simplify some doxygen

Browse Source
This commit is contained in:
Karl Palsson 2019-12-25 13:43:03 +00:00
parent a3406f100b
commit fa3c1df6f5
4 changed files with 34 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
include/libopencm3/pac55xx/ccs.h
View File

@ -1,6 +1,5 @@
/** @file /**
* * @brief Clock Control and System Defines for the Qorvo PAC55xx series of microcontrollers.
* Clock Control and System Defines for the Qorvo PAC55xx series of microcontrollers.
* *
* @defgroup system_defines Clock Config and System Defines * @defgroup system_defines Clock Config and System Defines
* @ingroup PAC55xx_defines * @ingroup PAC55xx_defines
@ -32,9 +31,10 @@
#include <libopencm3/cm3/common.h> #include <libopencm3/cm3/common.h>
/**@{*/
/** Clock Control Registers /** Clock Control Registers
* @defgroup clock_config_regs Clock Config Registers. * @defgroup clock_config_regs Clock Config Registers.
* @ingroup system_defines
* @{*/ * @{*/
#define CCSCTL MMIO32(SCC_BASE) #define CCSCTL MMIO32(SCC_BASE)
#define CCSPLLCTL MMIO32(SCC_BASE + 0x04) #define CCSPLLCTL MMIO32(SCC_BASE + 0x04)
@ -43,7 +43,6 @@
/** Port Pin Config Addresses /** Port Pin Config Addresses
* @defgroup port_pin_addresses Port Pinmux Register Base. * @defgroup port_pin_addresses Port Pinmux Register Base.
* @ingroup system_defines
* @{*/ * @{*/
#define CCS_PORTA (SCC_BASE + 0x0C) #define CCS_PORTA (SCC_BASE + 0x0C)
#define CCS_PORTB (SCC_BASE + 0x10) #define CCS_PORTB (SCC_BASE + 0x10)
@ -56,7 +55,6 @@
/** Port Pin Mux Select Registers /** Port Pin Mux Select Registers
* @defgroup pmux_sel_regs PMUXSEL register mapping. * @defgroup pmux_sel_regs PMUXSEL register mapping.
* @ingroup system_defines
* @{*/ * @{*/
#define CCS_MUXSELR(base) MMIO32(base) #define CCS_MUXSELR(base) MMIO32(base)
#define CCS_PAMUXSELR CCS_MUXSELR(CCS_PORTA) #define CCS_PAMUXSELR CCS_MUXSELR(CCS_PORTA)
@ -82,7 +80,6 @@ typedef enum {
/** Port Pull-Up/Down Enable Registers. /** Port Pull-Up/Down Enable Registers.
* @defgroup pden_regs PUEN PDEN register mapping. * @defgroup pden_regs PUEN PDEN register mapping.
* @ingroup system_defines
* @{*/ * @{*/
#define CCS_PUENR(base) MMIO32(base + 0x1C) #define CCS_PUENR(base) MMIO32(base + 0x1C)
#define CCS_PAPUENR CCS_PUENR(CCS_PORTA) #define CCS_PAPUENR CCS_PUENR(CCS_PORTA)
@ -100,7 +97,7 @@ typedef enum {
#define CCS_PEPDENR CCS_PDENR(CCS_PORTE) #define CCS_PEPDENR CCS_PDENR(CCS_PORTE)
#define CCS_PFPDENR CCS_PDENR(CCS_PORTF) #define CCS_PFPDENR CCS_PDENR(CCS_PORTF)
#define CCS_PGPDENR CCS_PDENR(CCS_PORTG) #define CCS_PGPDENR CCS_PDENR(CCS_PORTG)
/* Pull Up/Down enum for type specificity. */ /** Pull Up/Down enum for type specificity. */
typedef enum { typedef enum {
CCS_IO_PULL_NONE = 0, CCS_IO_PULL_NONE = 0,
CCS_IO_PULL_UP = 1, CCS_IO_PULL_UP = 1,
@ -110,7 +107,6 @@ typedef enum {
/** Port Drive Strength Enable Registers. /** Port Drive Strength Enable Registers.
* @defgroup dsr_regs DSR register mapping. * @defgroup dsr_regs DSR register mapping.
* @ingroup system_defines
* @{*/ * @{*/
#define CCS_DSR(base) MMIO32(base + 0x54) #define CCS_DSR(base) MMIO32(base + 0x54)
#define CCS_PADSR CCS_DSR(CCS_PORTA) #define CCS_PADSR CCS_DSR(CCS_PORTA)
@ -125,7 +121,7 @@ typedef enum {
#define CCS_DSR_DS_VAL(pin, ds) (((ds)&CCS_DSR_MASK) << ((pin)*4)) #define CCS_DSR_DS_VAL(pin, ds) (((ds)&CCS_DSR_MASK) << ((pin)*4))
#define CCS_DSR_SCHMIDT_PIN(pin) (BIT0 << (((pin)*4) + 3)) #define CCS_DSR_SCHMIDT_PIN(pin) (BIT0 << (((pin)*4) + 3))
/* Drive strength enumeration for type specificity. */ /** Drive strength enumeration for type specificity. */
typedef enum { typedef enum {
CCS_DSR_DS_6MA = 0x00, CCS_DSR_DS_6MA = 0x00,
CCS_DSR_DS_8MA = 0x01, CCS_DSR_DS_8MA = 0x01,
@ -137,5 +133,6 @@ typedef enum {
CCS_DSR_DS_25MA = 0x07, CCS_DSR_DS_25MA = 0x07,
} ccs_drive_strength_t; } ccs_drive_strength_t;
/**@}*/ /**@}*/
/**@}*/
#endif /* INCLUDE_LIBOPENCM3_PAC55XX_CCS_H_ */ #endif /* INCLUDE_LIBOPENCM3_PAC55XX_CCS_H_ */

56
include/libopencm3/pac55xx/gpio.h
View File

@ -1,6 +1,5 @@
/** @file /**
* * @brief GPIO definitions for the Qorvo PAC55xx series of microcontrollers.
* GPIO definitions for the Qorvo PAC55xx series of microcontrollers.
* *
* @addtogroup PAC55xx_gpio GPIO * @addtogroup PAC55xx_gpio GPIO
* @ingroup PAC55xx_defines * @ingroup PAC55xx_defines
@ -36,9 +35,10 @@
#include <libopencm3/pac55xx/ccs.h> #include <libopencm3/pac55xx/ccs.h>
#include <libopencm3/pac55xx/memorymap.h> #include <libopencm3/pac55xx/memorymap.h>
/**@{*/
/** GPIO port base addresses (for convenience) /** GPIO port base addresses (for convenience)
* @defgroup gpio_port_id GPIO Port IDs * @defgroup gpio_port_id GPIO Port IDs
* @ingroup PAC55xx_gpio
* @{*/ * @{*/
#define GPIOA GPIOA_BASE #define GPIOA GPIOA_BASE
#define GPIOB GPIOB_BASE #define GPIOB GPIOB_BASE
@ -51,7 +51,6 @@
/** GPIO number definitions (for convenience) /** GPIO number definitions (for convenience)
* @defgroup gpio_pin_id GPIO Pin Identifiers * @defgroup gpio_pin_id GPIO Pin Identifiers
* @ingroup PAC55xx_gpio
* @{*/ * @{*/
#define GPIO_MAX_PIN (7U) #define GPIO_MAX_PIN (7U)
#define GPIO0 BIT0 #define GPIO0 BIT0
@ -67,7 +66,6 @@
/** GPIO Mode Register Definitions /** GPIO Mode Register Definitions
* @defgroup gpio_mode_regs GPIO MODE register mapping. * @defgroup gpio_mode_regs GPIO MODE register mapping.
* @ingroup PAC55xx_gpio
* @{*/ * @{*/
/* Enum definitions for at least minimal type safety. */ /* Enum definitions for at least minimal type safety. */
typedef enum { typedef enum {
@ -92,7 +90,6 @@ typedef enum {
/** GPIO Output Mask Register Definitions. This register may be used to lock the output value of /** GPIO Output Mask Register Definitions. This register may be used to lock the output value of
* a pin as changes to masked pins will have no effect. * a pin as changes to masked pins will have no effect.
* @defgroup gpio_outmask_regs GPIO OUTMASK register mapping. * @defgroup gpio_outmask_regs GPIO OUTMASK register mapping.
* @ingroup PAC55xx_gpio
* @{*/ * @{*/
#define GPIO_OUTMASKR(base) MMIO32((base) + 0x04) #define GPIO_OUTMASKR(base) MMIO32((base) + 0x04)
#define GPIOA_OUTMASKR GPIO_OUTMASKR(GPIOA) #define GPIOA_OUTMASKR GPIO_OUTMASKR(GPIOA)
@ -106,7 +103,6 @@ typedef enum {
/** GPIO Output Register Definitions. /** GPIO Output Register Definitions.
* @defgroup gpio_out_regs GPIO OUT register mapping. * @defgroup gpio_out_regs GPIO OUT register mapping.
* @ingroup PAC55xx_gpio
* @{*/ * @{*/
#define GPIO_OUTR(base) MMIO32((base) + 0x08) #define GPIO_OUTR(base) MMIO32((base) + 0x08)
#define GPIOA_OUTR GPIO_OUTR(GPIOA) #define GPIOA_OUTR GPIO_OUTR(GPIOA)
@ -119,8 +115,7 @@ typedef enum {
/**@}*/ /**@}*/
/** GPIO Input Register Definitions. /** GPIO Input Register Definitions.
* @defgroup gpio_out_regs GPIO IN register mapping. * @defgroup gpio_in_regs GPIO IN register mapping.
* @ingroup PAC55xx_gpio
* @{*/ * @{*/
#define GPIO_INR(base) MMIO32((base) + 0x0C) #define GPIO_INR(base) MMIO32((base) + 0x0C)
#define GPIOA_INR GPIO_INR(GPIOA) #define GPIOA_INR GPIO_INR(GPIOA)
@ -134,7 +129,6 @@ typedef enum {
/** GPIO Interrupt Enable Register Definitions. /** GPIO Interrupt Enable Register Definitions.
* @defgroup gpio_inten_regs GPIO INTEN register mapping. * @defgroup gpio_inten_regs GPIO INTEN register mapping.
* @ingroup PAC55xx_gpio
* @{*/ * @{*/
#define GPIO_INTENR(base) MMIO32((base) + 0x10) #define GPIO_INTENR(base) MMIO32((base) + 0x10)
#define GPIOA_INTENR GPIO_INTENR(GPIOA) #define GPIOA_INTENR GPIO_INTENR(GPIOA)
@ -148,7 +142,6 @@ typedef enum {
/** GPIO Interrupt Flag Register Definitions. /** GPIO Interrupt Flag Register Definitions.
* @defgroup gpio_intflag_regs GPIO INTFLAG register mapping. * @defgroup gpio_intflag_regs GPIO INTFLAG register mapping.
* @ingroup PAC55xx_gpio
* @{*/ * @{*/
#define GPIO_INTFLAGR(base) MMIO32((base) + 0x14) #define GPIO_INTFLAGR(base) MMIO32((base) + 0x14)
#define GPIOA_INTFLAGR GPIO_INTFLAGR(GPIOA) #define GPIOA_INTFLAGR GPIO_INTFLAGR(GPIOA)
@ -162,7 +155,6 @@ typedef enum {
/** GPIO Interrupt Clear Register Definitions. /** GPIO Interrupt Clear Register Definitions.
* @defgroup gpio_intclear_regs GPIO INTCLEAR register mapping. * @defgroup gpio_intclear_regs GPIO INTCLEAR register mapping.
* @ingroup PAC55xx_gpio
* @{*/ * @{*/
#define GPIO_INTCLEARR(base) MMIO32((base) + 0x1C) #define GPIO_INTCLEARR(base) MMIO32((base) + 0x1C)
#define GPIOA_INTCLEARR GPIO_INTCLEARR(GPIOA) #define GPIOA_INTCLEARR GPIO_INTCLEARR(GPIOA)
@ -176,7 +168,6 @@ typedef enum {
/** GPIO Interrupt Type Register Definitions. /** GPIO Interrupt Type Register Definitions.
* @defgroup gpio_inttype_regs GPIO INTTYPE register mapping. * @defgroup gpio_inttype_regs GPIO INTTYPE register mapping.
* @ingroup PAC55xx_gpio
* @{*/ * @{*/
#define GPIO_INTTYPE_EDGE 0U #define GPIO_INTTYPE_EDGE 0U
#define GPIO_INTTYPE_LEVEL 1U #define GPIO_INTTYPE_LEVEL 1U
@ -192,7 +183,6 @@ typedef enum {
/** GPIO Interrupt Config Register Definitions. /** GPIO Interrupt Config Register Definitions.
* @defgroup gpio_intcfg_regs GPIO INTCFG register mapping. * @defgroup gpio_intcfg_regs GPIO INTCFG register mapping.
* @ingroup PAC55xx_gpio
* @{*/ * @{*/
#define GPIO_INTCFG_FALLING_LOW 0U #define GPIO_INTCFG_FALLING_LOW 0U
#define GPIO_INTCFG_RISING_HIGH 1U #define GPIO_INTCFG_RISING_HIGH 1U
@ -208,7 +198,6 @@ typedef enum {
/** GPIO Interrupt Edge Both Definitions. This overrides the config if set. /** GPIO Interrupt Edge Both Definitions. This overrides the config if set.
* @defgroup gpio_intedgeboth_regs GPIO INTEDGEBOTH register mapping. * @defgroup gpio_intedgeboth_regs GPIO INTEDGEBOTH register mapping.
* @ingroup PAC55xx_gpio
* @{*/ * @{*/
#define GPIO_INTEDGEBOTHR(base) MMIO32((base) + 0x28) #define GPIO_INTEDGEBOTHR(base) MMIO32((base) + 0x28)
#define GPIOA_INTEDGEBOTHR GPIO_INTEDGEBOTHR(GPIOA) #define GPIOA_INTEDGEBOTHR GPIO_INTEDGEBOTHR(GPIOA)
@ -222,7 +211,6 @@ typedef enum {
/** GPIO Clock Synchronization Settings. When set, this enables 3-clock synchronizer on pins. /** GPIO Clock Synchronization Settings. When set, this enables 3-clock synchronizer on pins.
* @defgroup gpio_clksync_regs GPIO CLKSYNC register mapping. * @defgroup gpio_clksync_regs GPIO CLKSYNC register mapping.
* @ingroup PAC55xx_gpio
* @{*/ * @{*/
#define GPIO_CLKSYNCR(base) MMIO32((base) + 0x2C) #define GPIO_CLKSYNCR(base) MMIO32((base) + 0x2C)
#define GPIOA_CLKSYNCR GPIO_CLKSYNCR(GPIOA) #define GPIOA_CLKSYNCR GPIO_CLKSYNCR(GPIOA)
@ -236,7 +224,6 @@ typedef enum {
/** GPIO Set Register. This register can be used for atomic setting of outputs. /** GPIO Set Register. This register can be used for atomic setting of outputs.
* @defgroup gpio_doset_regs GPIO DOSET register mapping. * @defgroup gpio_doset_regs GPIO DOSET register mapping.
* @ingroup PAC55xx_gpio
* @{*/ * @{*/
#define GPIO_DOSETR(base) MMIO32((base) + 0x30) #define GPIO_DOSETR(base) MMIO32((base) + 0x30)
#define GPIOA_DOSETR GPIO_DOSETR(GPIOA) #define GPIOA_DOSETR GPIO_DOSETR(GPIOA)
@ -250,7 +237,6 @@ typedef enum {
/** GPIO Set Register. This register can be used for atomic setting of outputs. /** GPIO Set Register. This register can be used for atomic setting of outputs.
* @defgroup gpio_doclear_regs GPIO DOCLEAR register mapping. * @defgroup gpio_doclear_regs GPIO DOCLEAR register mapping.
* @ingroup PAC55xx_gpio
* @{*/ * @{*/
#define GPIO_DOCLEARR(base) MMIO32((base) + 0x34) #define GPIO_DOCLEARR(base) MMIO32((base) + 0x34)
#define GPIOA_DOCLEARR GPIO_DOCLEARR(GPIOA) #define GPIOA_DOCLEARR GPIO_DOCLEARR(GPIOA)
@ -262,6 +248,8 @@ typedef enum {
#define GPIOG_DOCLEARR GPIO_DOCLEARR(GPIOG) #define GPIOG_DOCLEARR GPIO_DOCLEARR(GPIOG)
/**@}*/ /**@}*/
/**@}*/
BEGIN_DECLS BEGIN_DECLS
/** GPIO Application Programming Interface. /** GPIO Application Programming Interface.
* @defgroup gpio_api GPIO Peripheral API * @defgroup gpio_api GPIO Peripheral API
@ -269,10 +257,10 @@ BEGIN_DECLS
@{*/ @{*/
/** /**
* Set the IO mode and pull-up/down configuration for the pins. * Set the IO mode and pull-up/down configuration for the pins.
* @param gpioport[in] Port to configure the alternate function on. * @param[in] gpioport Port to configure the alternate function on.
* @param mode[in] IO Mode to configure (analog, input, output). * @param[in] mode IO Mode to configure (analog, input, output).
* @param pull_up_down[in] Pull configuration (up/down/none) to set for the pins.. * @param[in] pull_up_down Pull configuration (up/down/none) to set for the pins..
* @param gpios[in] Pins to set with the mode and pull config specified. * @param[in] gpios Pins to set with the mode and pull config specified.
*/ */
void gpio_mode_setup(uint32_t gpioport, gpio_mode_t mode, void gpio_mode_setup(uint32_t gpioport, gpio_mode_t mode,
ccs_pull_updown_t pull_up_down, uint16_t gpios); ccs_pull_updown_t pull_up_down, uint16_t gpios);
@ -297,32 +285,32 @@ void gpio_set(uint32_t gpioport, uint16_t gpios);
void gpio_clear(uint32_t gpioport, uint16_t gpios); void gpio_clear(uint32_t gpioport, uint16_t gpios);
/** /**
* Return a masked bitfield of the port specified. * Return a masked bitfield of the port specified.
* @param gpioport[in] Port to read the bits from. * @param[in] gpioport Port to read the bits from.
* @param gpios[in] bitfield mask to apply to the port read. * @param[in] gpios bitfield mask to apply to the port read.
* @return masked bitfield of the port. * @return masked bitfield of the port.
*/ */
uint16_t gpio_get(uint32_t gpioport, uint16_t gpios); uint16_t gpio_get(uint32_t gpioport, uint16_t gpios);
/** /**
* Set the function of the pin for this port. This will modify the pinmux, * Set the function of the pin for this port. This will modify the pinmux,
* @param gpioport[in] Port to configure the alternate function on. * @param[in] gpioport Port to configure the alternate function on.
* @param muxsel[in] Mux select mode to configure on the port and pins. * @param[in] muxsel Mux select mode to configure on the port and pins.
* @param gpios[in] Pins to set with the function specified. * @param[in] gpios Pins to set with the function specified.
*/ */
void gpio_set_af(uint32_t gpioport, ccs_muxsel_func_t muxsel, uint16_t gpios); void gpio_set_af(uint32_t gpioport, ccs_muxsel_func_t muxsel, uint16_t gpios);
/** /**
* Set special output options for the gpio pin. For this MCU, this is only the drive strength. * Set special output options for the gpio pin. For this MCU, this is only the drive strength.
* @param gpioport[in] Port to configure the alternate function on. * @param[in] gpioport Port to configure the alternate function on.
* @param strength[in] Drive strength (DS_XXMA from ccs.h). * @param[in] strength Drive strength (DS_XXMA from ccs.h).
* @param gpios[in] Pins to set with the drive strength specified. * @param[in] gpios Pins to set with the drive strength specified.
*/ */
void gpio_set_output_options(uint32_t gpioport, ccs_drive_strength_t strength, void gpio_set_output_options(uint32_t gpioport, ccs_drive_strength_t strength,
uint16_t gpios); uint16_t gpios);
/** /**
* Set input schmidt trigger for glitch rejection on the input pin. * Set input schmidt trigger for glitch rejection on the input pin.
* @param gpioport[in] Port to configure the alternate function on. * @param[in] gpioport Port to configure the alternate function on.
* @param enable[in] True to enable, false to disable the schmidt trigger. * @param[in] enable True to enable, false to disable the schmidt trigger.
* @param gpios[in] Pins to set with the schmidt trigger setting specified. * @param[in] gpios Pins to set with the schmidt trigger setting specified.
*/ */
void gpio_set_schmidt_trigger(uint32_t gpioport, bool enable, uint16_t gpios); void gpio_set_schmidt_trigger(uint32_t gpioport, bool enable, uint16_t gpios);
/**@}*/ /**@}*/

12
include/libopencm3/pac55xx/memorymap.h
View File

@ -1,7 +1,5 @@
/** @file /**
* @defgroup memorymap * @defgroup memorymap Peripheral Memory Map
*
* Peripheral Memory Map for the PAC55xx series of microcontrolelrs.
* *
* @ingroup PAC55xx_defines * @ingroup PAC55xx_defines
* @author Brian Viele <vielster@allocor.tech> * @author Brian Viele <vielster@allocor.tech>
@ -27,10 +25,9 @@
#ifndef INCLUDE_LIBOPENCM3_PAC55XX_MEMORYMAP_H_ #ifndef INCLUDE_LIBOPENCM3_PAC55XX_MEMORYMAP_H_
#define INCLUDE_LIBOPENCM3_PAC55XX_MEMORYMAP_H_ #define INCLUDE_LIBOPENCM3_PAC55XX_MEMORYMAP_H_
/* Memory and Peripheral memory Mapping */ /**@{*/
/** @defgroup address_memory Address Memory Map. /** @defgroup address_memory Address Memory Map.
@ingroup memorymap
@{*/ @{*/
#define FLASH_BASE (0x00000000UL) #define FLASH_BASE (0x00000000UL)
#define INFO1_FLASH_BASE (0x00100000UL) #define INFO1_FLASH_BASE (0x00100000UL)
@ -40,7 +37,6 @@
#define PERIPH_BASE (0x40000000UL) #define PERIPH_BASE (0x40000000UL)
/**@}*/ /**@}*/
/** @defgroup peripheral_addresses Core Peripheral Memory Map. /** @defgroup peripheral_addresses Core Peripheral Memory Map.
@ingroup memorymap
@{*/ @{*/
#define ADC_BASE (PERIPH_BASE + 0x00000) #define ADC_BASE (PERIPH_BASE + 0x00000)
#define I2C_BASE (PERIPH_BASE + 0x10000) #define I2C_BASE (PERIPH_BASE + 0x10000)
@ -58,7 +54,6 @@
#define SYS_PERIPH_BASE (PERIPH_BASE + 0xD0000) #define SYS_PERIPH_BASE (PERIPH_BASE + 0xD0000)
/**@}*/ /**@}*/
/** @defgroup system_peripheral_addresses System Peripheral Memory Map. /** @defgroup system_peripheral_addresses System Peripheral Memory Map.
@ingroup memorymap
@{*/ @{*/
#define MEMCTL_BASE (SYS_PERIPH_BASE + 0x0000) #define MEMCTL_BASE (SYS_PERIPH_BASE + 0x0000)
#define SCC_BASE (SYS_PERIPH_BASE + 0x0400) #define SCC_BASE (SYS_PERIPH_BASE + 0x0400)
@ -73,5 +68,6 @@
#define GPIOF_BASE (SYS_PERIPH_BASE + 0x2800) #define GPIOF_BASE (SYS_PERIPH_BASE + 0x2800)
#define GPIOG_BASE (SYS_PERIPH_BASE + 0x2C00) #define GPIOG_BASE (SYS_PERIPH_BASE + 0x2C00)
/**@}*/ /**@}*/
/**@}*/
#endif /* INCLUDE_LIBOPENCM3_PAC55XX_MEMORYMAP_H_ */ #endif /* INCLUDE_LIBOPENCM3_PAC55XX_MEMORYMAP_H_ */

2
lib/pac55xx/gpio.c
View File

@ -1,4 +1,4 @@
/** @file /**
* @ingroup PAC55xx_gpio * @ingroup PAC55xx_gpio
* @brief <b>PAC55xxxx General-Purpose Input/Output (GPIO)</b> * @brief <b>PAC55xxxx General-Purpose Input/Output (GPIO)</b>
* @author @htmlonly &copy; @endhtmlonly 2019 Brian Viele <vielster@allocor.tech> * @author @htmlonly &copy; @endhtmlonly 2019 Brian Viele <vielster@allocor.tech>