EMTime/libopencm3
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

samd: doc: links and spelling

Browse Source 
Fixes all doxygen warnings for samd. yay
This commit is contained in:
Karl Palsson
2021-02-03 23:22:52 +00:00
parent 49327dcdc4
commit 7b88c2d9d2
2 changed files with 13 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
include/libopencm3/sam/d/port.h
View File

@@ -18,8 +18,12 @@
/* --- Convenience macros ------------------------------------------------ */ /* --- Convenience macros ------------------------------------------------ */
/**@defgroup port_reg_base Port Base registers
* @{
*/
#define PORTA (PORT_BASE + 0) #define PORTA (PORT_BASE + 0)
#define PORTB (PORT_BASE + 0x80) #define PORTB (PORT_BASE + 0x80)
/**@}*/
/* GPIO number definitions (for convenience) */ /* GPIO number definitions (for convenience) */
/** @defgroup gpio_pin_id GPIO Pin Identifiers /** @defgroup gpio_pin_id GPIO Pin Identifiers

18
lib/sam/d/port.c
View File

@@ -17,8 +17,8 @@
* @param[in] gpioport port register address base @ref port_reg_base * @param[in] gpioport port register address base @ref port_reg_base
* @param[in] mode direction @ref gpio_direction * @param[in] mode direction @ref gpio_direction
* @param[in] cnf configuration mode @ref gpio_cnf * @param[in] cnf configuration mode @ref gpio_cnf
* @param[in] gpios Any combinaison of pins may be * @param[in] gpios @ref gpio_pin_id. Any combination of pins
* specified by OR'ing then together. * may be specified by OR'ing then together.
*/ */
void gpio_mode_setup(uint32_t gpioport, uint8_t mode, uint8_t cnf, uint32_t gpios) void gpio_mode_setup(uint32_t gpioport, uint8_t mode, uint8_t cnf, uint32_t gpios)
{ {
@@ -67,8 +67,8 @@ void gpio_mode_setup(uint32_t gpioport, uint8_t mode, uint8_t cnf, uint32_t gpio
* *
* @param[in] gpioport port register address base @ref port_reg_base * @param[in] gpioport port register address base @ref port_reg_base
* @param[in] af pmux configuration @ref gpio_mux * @param[in] af pmux configuration @ref gpio_mux
* @param[in] gpios Any combinaison of pins may be * @param[in] gpios @ref gpio_pin_id. Any combination of pins
* specified by OR'ing then together. * may be specified by OR'ing then together.
*/ */
void gpio_set_af(uint32_t gpioport, uint8_t af, uint32_t gpios) void gpio_set_af(uint32_t gpioport, uint8_t af, uint32_t gpios)
{ {
@@ -89,7 +89,7 @@ void gpio_set_af(uint32_t gpioport, uint8_t af, uint32_t gpios)
* Set a group of Pins for the given port. * Set a group of Pins for the given port.
* *
* @param[in] gpioport port register address base @ref port_reg_base * @param[in] gpioport port register address base @ref port_reg_base
* @param[in] gpios @ref gpio_defines. Any combinaison of pins may be * @param[in] gpios @ref gpio_pin_id. Any combination of pins may be
* specified by OR'ing then together. * specified by OR'ing then together.
*/ */
void gpio_set(uint32_t gpioport, uint32_t gpios) void gpio_set(uint32_t gpioport, uint32_t gpios)
@@ -102,7 +102,7 @@ void gpio_set(uint32_t gpioport, uint32_t gpios)
* Clear a group of Pins for the given port. * Clear a group of Pins for the given port.
* *
* @param[in] gpioport port register address base @ref port_reg_base * @param[in] gpioport port register address base @ref port_reg_base
* @param[in] gpios @ref gpio_defines. Any combinaison of pins may be * @param[in] gpios @ref gpio_pin_id. Any combination of pins may be
* specified by OR'ing then together. * specified by OR'ing then together.
*/ */
void gpio_clear(uint32_t gpioport, uint32_t gpios) void gpio_clear(uint32_t gpioport, uint32_t gpios)
@@ -115,7 +115,7 @@ void gpio_clear(uint32_t gpioport, uint32_t gpios)
* Read the level of a group of Pins for the given port. * Read the level of a group of Pins for the given port.
* *
* @param[in] gpioport port register address base @ref port_reg_base * @param[in] gpioport port register address base @ref port_reg_base
* @param[in] gpios @ref gpio_defines. Any combinaison of pins may be * @param[in] gpios @ref gpio_pin_id. Any combination of pins may be
* specified by OR'ing then together. * specified by OR'ing then together.
*/ */
uint32_t gpio_get(uint32_t gpioport, uint32_t gpios) uint32_t gpio_get(uint32_t gpioport, uint32_t gpios)
@@ -128,7 +128,7 @@ uint32_t gpio_get(uint32_t gpioport, uint32_t gpios)
* Toggle one or more pins of the givent port. * Toggle one or more pins of the givent port.
* *
* @param[in] gpioport port register address base @ref port_reg_base * @param[in] gpioport port register address base @ref port_reg_base
* @param[in] gpios @ref gpio_defines. Any combinaison of pins may be * @param[in] gpios @ref gpio_pin_id. Any combination of pins may be
* specified by OR'ing then together. * specified by OR'ing then together.
*/ */
void gpio_toggle(uint32_t gpioport, uint32_t gpios) void gpio_toggle(uint32_t gpioport, uint32_t gpios)
@@ -154,7 +154,7 @@ uint32_t port_read(uint32_t port)
* Set the level of all pins of the given port. * Set the level of all pins of the given port.
* *
* @param[in] port register address base @ref port_reg_base * @param[in] port register address base @ref port_reg_base
* @param[in] data @ref gpio_defines. Any combinaison of pins * @param[in] data @ref gpio_pin_id. Any combination of pins
* may be specified by OR'ing then together. * may be specified by OR'ing then together.
*/ */
void port_write(uint32_t port, uint32_t data) void port_write(uint32_t port, uint32_t data)