diff --git a/annotated.html b/annotated.html index bd6ae1e..45ece97 100644 --- a/annotated.html +++ b/annotated.html @@ -77,10 +77,10 @@ - - - - + + + +
 Cfifo_buffer_t
 Cgossamer_dma_job_t
 Crtc_date_time
 CSERCOM_Instance_Details
 CTC_Instance_Details
 CTCC_Instance_Details
 Crtc_date_time_t
 Csercom_instance_details_t
 Ctc_instance_details_t
 Ctcc_instance_details_t
diff --git a/classes.html b/classes.html index c96108d..95c6da7 100644 --- a/classes.html +++ b/classes.html @@ -83,13 +83,13 @@
gossamer_dma_job_t
R
-
rtc_date_time
+
rtc_date_time_t
S
-
SERCOM_Instance_Details
+
sercom_instance_details_t
T
-
TC_Instance_Details
TCC_Instance_Details
+
tc_instance_details_t
tcc_instance_details_t
diff --git a/eic_8h.html b/eic_8h.html index 3c3d13d..319aa6d 100644 --- a/eic_8h.html +++ b/eic_8h.html @@ -91,23 +91,23 @@ - - - + + +

Typedefs

-typedef enum eic_interrupt_trigger eic_interrupt_trigger
 An enum defining the types of interrupt trigger you wish to scan for.
 
+typedef enum eic_interrupt_trigger_t eic_interrupt_trigger_t
 An enum defining the types of interrupt trigger you wish to scan for.
 
typedef void(* eic_cb_t) (uint8_t channel)
 
- - - + +

Enumerations

enum  eic_interrupt_trigger { INTERRUPT_TRIGGER_NONE = 0 +
enum  eic_interrupt_trigger_t { INTERRUPT_TRIGGER_NONE = 0 , INTERRUPT_TRIGGER_RISING , INTERRUPT_TRIGGER_FALLING , INTERRUPT_TRIGGER_BOTH }
 An enum defining the types of interrupt trigger you wish to scan for.
 
 An enum defining the types of interrupt trigger you wish to scan for.
 
@@ -119,9 +119,9 @@ void  - - - + + + @@ -172,8 +172,8 @@

-

◆ eic_configure_pin()

+ +

◆ eic_configure_pin()

@@ -187,7 +187,7 @@

- + diff --git a/eic_8h_source.html b/eic_8h_source.html index dc4e651..f3fcfee 100644 --- a/eic_8h_source.html +++ b/eic_8h_source.html @@ -113,12 +113,12 @@
32#include <stdbool.h>
33
-
35typedef enum eic_interrupt_trigger {
+
35typedef enum eic_interrupt_trigger_t {
36 INTERRUPT_TRIGGER_NONE = 0,
37 INTERRUPT_TRIGGER_RISING,
38 INTERRUPT_TRIGGER_FALLING,
39 INTERRUPT_TRIGGER_BOTH,
-
40} eic_interrupt_trigger;
+
40} eic_interrupt_trigger_t;
41
42typedef void (*eic_cb_t)(uint8_t channel);
@@ -127,7 +127,7 @@
47
50void eic_enable(void);
51
-
63int8_t eic_configure_pin(const uint8_t pin, eic_interrupt_trigger trigger);
+
63int8_t eic_configure_pin(const uint8_t pin, eic_interrupt_trigger_t trigger);
64
68bool eic_enable_interrupt(const uint8_t pin);
69
@@ -140,13 +140,13 @@
91void eic_configure_callback(eic_cb_t callback);
92
95void eic_disable(void);
+
eic_configure_pin
int8_t eic_configure_pin(const uint8_t pin, eic_interrupt_trigger_t trigger)
Configures an external interrupt on one of the external interrupt pins.
Definition eic.c:99
eic_disable_event
bool eic_disable_event(const uint8_t pin)
Disables the interrupt on the given interrupt channel.
Definition eic.c:190
-
eic_configure_pin
int8_t eic_configure_pin(const uint8_t pin, eic_interrupt_trigger trigger)
Configures an external interrupt on one of the external interrupt pins.
Definition eic.c:99
eic_disable_interrupt
bool eic_disable_interrupt(const uint8_t pin)
Disables the interrupt on the given interrupt channel.
Definition eic.c:150
eic_configure_callback
void eic_configure_callback(eic_cb_t callback)
Configures an external interrupt callback.
Definition eic.c:219
-
eic_interrupt_trigger
eic_interrupt_trigger
An enum defining the types of interrupt trigger you wish to scan for.
Definition eic.h:35
eic_enable_interrupt
bool eic_enable_interrupt(const uint8_t pin)
Enables an interrupt on the given interrupt channel.
Definition eic.c:129
eic_disable
void eic_disable(void)
Disables the external interrupt controller.
Definition eic.c:209
+
eic_interrupt_trigger_t
eic_interrupt_trigger_t
An enum defining the types of interrupt trigger you wish to scan for.
Definition eic.h:35
eic_init
void eic_init(void)
Initializes the external interrupt controller, but does not enable it.
Definition eic.c:62
eic_enable_event
bool eic_enable_event(const uint8_t pin)
Enables an interrupt on the given interrupt channel.
Definition eic.c:171
eic_enable
void eic_enable(void)
Enables the external interrupt controller.
Definition eic.c:87
diff --git a/globals.html b/globals.html index c3b9b2f..28dd13c 100644 --- a/globals.html +++ b/globals.html @@ -105,7 +105,7 @@

- d -

Functions

eic_enable (void)
 Enables the external interrupt controller.
 
int8_t eic_configure_pin (const uint8_t pin, eic_interrupt_trigger trigger)
 Configures an external interrupt on one of the external interrupt pins.
 
int8_t eic_configure_pin (const uint8_t pin, eic_interrupt_trigger_t trigger)
 Configures an external interrupt on one of the external interrupt pins.
 
bool eic_enable_interrupt (const uint8_t pin)
 Enables an interrupt on the given interrupt channel.
 
eic_interrupt_trigger eic_interrupt_trigger_t  trigger 
- - +

Enumerations

enum  I2CResult {
+
enum  i2c_result_t {
  I2C_RESULT_SUCCESS = 0 , I2C_RESULT_ERR_ADDR_NACK = -1 , I2C_RESULT_ERR_BUSSTATE = -2 @@ -100,7 +100,7 @@   I2C_RESULT_ERR_DATA_NACK = -4
}
 
 
@@ -111,12 +111,12 @@ void  - - - - - - + + + + + + @@ -127,12 +127,12 @@ - - - - - - + + + + + + @@ -251,14 +251,14 @@

-

◆ i2c_read()

+ +

◆ i2c_read()

Functions

i2c_enable (void)
 Enables the I2C peripheral for a board with defined SDA/SCL pins.
 
I2CResult i2c_write (uint8_t address, uint8_t *data, size_t len)
 Writes data to an I2C device at the provided address.
 
I2CResult i2c_read (uint8_t address, uint8_t *data, size_t len)
 Reads data from an I2C device at the provided address.
 
i2c_result_t i2c_write (uint8_t address, uint8_t *data, size_t len)
 Writes data to an I2C device at the provided address.
 
i2c_result_t i2c_read (uint8_t address, uint8_t *data, size_t len)
 Reads data from an I2C device at the provided address.
 
void i2c_disable (void)
 Disables the I2C peripheral for a board with defined SDA/SCL pins.
void i2c_enable_instance (uint8_t sercom)
 Enables the I2C peripheral on the given SERCOM.
 
I2CResult i2c_write_instance (uint8_t sercom, uint8_t address, uint8_t *data, size_t len)
 Writes data to an I2C device on the given SERCOM at the provided address.
 
I2CResult i2c_read_instance (uint8_t sercom, uint8_t address, uint8_t *data, size_t len)
 Reads data from an I2C device on the given SERCOM at the provided address.
 
i2c_result_t i2c_write_instance (uint8_t sercom, uint8_t address, uint8_t *data, size_t len)
 Writes data to an I2C device on the given SERCOM at the provided address.
 
i2c_result_t i2c_read_instance (uint8_t sercom, uint8_t address, uint8_t *data, size_t len)
 Reads data from an I2C device on the given SERCOM at the provided address.
 
void i2c_disable_instance (uint8_t sercom)
 Disables the I2C peripheral on the given SERCOM.
 
- + @@ -295,14 +295,14 @@

-

◆ i2c_read_instance()

+ +

◆ i2c_read_instance()

I2CResult i2c_read i2c_result_t i2c_read ( uint8_t  address,
- + @@ -346,14 +346,14 @@

-

◆ i2c_write()

+ +

◆ i2c_write()

I2CResult i2c_read_instance i2c_result_t i2c_read_instance ( uint8_t  sercom,
- + @@ -390,14 +390,14 @@

-

◆ i2c_write_instance()

+ +

◆ i2c_write_instance()

I2CResult i2c_write i2c_result_t i2c_write ( uint8_t  address,
- + diff --git a/i2c_8h_source.html b/i2c_8h_source.html index ea158f1..34b8d90 100644 --- a/i2c_8h_source.html +++ b/i2c_8h_source.html @@ -105,15 +105,15 @@
24 I2C_RESULT_ERR_BUSSTATE = -2,
25 I2C_RESULT_ERR_BUSERR = -3,
26 I2C_RESULT_ERR_DATA_NACK = -4,
-
27} I2CResult;
+
27} i2c_result_t;
28
36void i2c_init(void);
37
41void i2c_enable(void);
42
-
49I2CResult i2c_write(uint8_t address, uint8_t* data, size_t len);
+
49i2c_result_t i2c_write(uint8_t address, uint8_t* data, size_t len);
50
-
57I2CResult i2c_read(uint8_t address, uint8_t* data, size_t len);
+
57i2c_result_t i2c_read(uint8_t address, uint8_t* data, size_t len);
58
62void i2c_disable(void);
63
@@ -121,21 +121,21 @@
73
78void i2c_enable_instance(uint8_t sercom);
79
-
87I2CResult i2c_write_instance(uint8_t sercom, uint8_t address, uint8_t* data, size_t len);
+
87i2c_result_t i2c_write_instance(uint8_t sercom, uint8_t address, uint8_t* data, size_t len);
88
-
96I2CResult i2c_read_instance(uint8_t sercom, uint8_t address, uint8_t* data, size_t len);
+
96i2c_result_t i2c_read_instance(uint8_t sercom, uint8_t address, uint8_t* data, size_t len);
97
102void i2c_disable_instance(uint8_t sercom);
+
i2c_write_instance
i2c_result_t i2c_write_instance(uint8_t sercom, uint8_t address, uint8_t *data, size_t len)
Writes data to an I2C device on the given SERCOM at the provided address.
Definition i2c.c:91
i2c_init
void i2c_init(void)
Initializes the I2C peripheral for a board with defined SDA/SCL pins. Defaults to a bus speed of 100k...
i2c_enable
void i2c_enable(void)
Enables the I2C peripheral for a board with defined SDA/SCL pins.
-
i2c_write_instance
I2CResult i2c_write_instance(uint8_t sercom, uint8_t address, uint8_t *data, size_t len)
Writes data to an I2C device on the given SERCOM at the provided address.
Definition i2c.c:91
+
i2c_write
i2c_result_t i2c_write(uint8_t address, uint8_t *data, size_t len)
Writes data to an I2C device at the provided address.
+
i2c_read_instance
i2c_result_t i2c_read_instance(uint8_t sercom, uint8_t address, uint8_t *data, size_t len)
Reads data from an I2C device on the given SERCOM at the provided address.
Definition i2c.c:144
i2c_enable_instance
void i2c_enable_instance(uint8_t sercom)
Enables the I2C peripheral on the given SERCOM.
Definition i2c.c:83
i2c_disable_instance
void i2c_disable_instance(uint8_t sercom)
Disables the I2C peripheral on the given SERCOM.
Definition i2c.c:190
-
i2c_write
I2CResult i2c_write(uint8_t address, uint8_t *data, size_t len)
Writes data to an I2C device at the provided address.
i2c_disable
void i2c_disable(void)
Disables the I2C peripheral for a board with defined SDA/SCL pins.
-
i2c_read_instance
I2CResult i2c_read_instance(uint8_t sercom, uint8_t address, uint8_t *data, size_t len)
Reads data from an I2C device on the given SERCOM at the provided address.
Definition i2c.c:144
-
i2c_read
I2CResult i2c_read(uint8_t address, uint8_t *data, size_t len)
Reads data from an I2C device at the provided address.
i2c_init_instance
void i2c_init_instance(uint8_t sercom, uint32_t baud)
Initializes an I2C peripheral on the given SERCOM.
Definition i2c.c:44
+
i2c_read
i2c_result_t i2c_read(uint8_t address, uint8_t *data, size_t len)
Reads data from an I2C device at the provided address.
I2CResult i2c_write_instance i2c_result_t i2c_write_instance ( uint8_t  sercom,
- +

Data Structures

union  rtc_date_time
union  rtc_date_time_t
 

@@ -104,21 +104,21 @@

- - + +

Typedefs

-typedef enum rtc_alarm_match rtc_alarm_match
 
+typedef enum rtc_alarm_match_t rtc_alarm_match_t
 
typedef void(* rtc_cb_t) (uint16_t intflag)
 
- - +

Enumerations

enum  rtc_alarm_match { ALARM_MATCH_DISABLED = 0 +
enum  rtc_alarm_match_t { ALARM_MATCH_DISABLED = 0 , ALARM_MATCH_SS , ALARM_MATCH_MMSS , ALARM_MATCH_HHMMSS }
 
 
@@ -132,15 +132,15 @@ - - - - - - - - - + + + + + + + + + @@ -178,8 +178,8 @@

-

◆ rtc_enable_alarm_interrupt()

+ +

◆ rtc_enable_alarm_interrupt()

@@ -187,13 +187,13 @@

void rtc_enable_alarm_interrupt

- + - + @@ -208,21 +208,21 @@

Parameters

Functions

bool rtc_is_enabled (void)
 Checks if the RTC is enabled.
 
void rtc_set_date_time (rtc_date_time date_time)
 Sets the date and time.
 
rtc_date_time rtc_get_date_time (void)
 Returns the date and time.
 
void rtc_enable_alarm_interrupt (rtc_date_time alarm_time, rtc_alarm_match mask)
 Enables the alarm interrupt.
 
void rtc_set_date_time (rtc_date_time_t date_time)
 Sets the date and time.
 
rtc_date_time_t rtc_get_date_time (void)
 Returns the date and time.
 
void rtc_enable_alarm_interrupt (rtc_date_time_t alarm_time, rtc_alarm_match_t mask)
 Enables the alarm interrupt.
 
void rtc_disable_alarm_interrupt (void)
 Disables the alarm callback.
(rtc_date_time rtc_date_time_t  alarm_time,
rtc_alarm_match rtc_alarm_match_t  mask 
- +
alarm_timeThe time that you wish to match. The date is currently ignored.
maskOne of the values in rtc_alarm_match indicating which values to check.
maskOne of the values in rtc_alarm_match_t indicating which values to check.
- -

◆ rtc_get_date_time()

+ +

◆ rtc_get_date_time()

- + @@ -232,8 +232,8 @@

Returns the date and time.

-
Returns
A rtc_date_time with the current date and time, with a year value from 0-63 representing 2020-2083.
-
See also
rtc_set_date_time for notes about how the year is stored.
+
Returns
A rtc_date_time_t with the current date and time, with a year value from 0-63 representing 2020-2083.
+
See also
rtc_set_date_time for notes about how the year is stored.
@@ -279,8 +279,8 @@

-

◆ rtc_set_date_time()

+ +

◆ rtc_set_date_time()

@@ -288,7 +288,7 @@

void rtc_set_date_time

- + diff --git a/rtc_8h_source.html b/rtc_8h_source.html index 63d1694..24221e7 100644 --- a/rtc_8h_source.html +++ b/rtc_8h_source.html @@ -115,7 +115,7 @@
34#define RTC_REFERENCE_YEAR (2020)
35
-
36typedef union {
+
36typedef union {
37 struct {
38 uint32_t second : 6; // 0-59
39 uint32_t minute : 6; // 0-59
@@ -125,15 +125,15 @@
43 uint32_t year : 6; // 0-63 (representing 2020-2083)
44 } unit;
45 uint32_t reg; // the bit-packed value as expected by the RTC peripheral's CLOCK register.
- +
47
-
48typedef enum rtc_alarm_match {
+
48typedef enum rtc_alarm_match_t {
49 ALARM_MATCH_DISABLED = 0,
50 ALARM_MATCH_SS,
51 ALARM_MATCH_MMSS,
52 ALARM_MATCH_HHMMSS,
-
53} rtc_alarm_match;
+
53} rtc_alarm_match_t;
54
55typedef void (*rtc_cb_t)(uint16_t intflag);
56
@@ -143,24 +143,24 @@
67
71bool rtc_is_enabled(void);
72
-
81void rtc_set_date_time(rtc_date_time date_time);
+
82
- +
88
-
93void rtc_enable_alarm_interrupt(rtc_date_time alarm_time, rtc_alarm_match mask);
+
93void rtc_enable_alarm_interrupt(rtc_date_time_t alarm_time, rtc_alarm_match_t mask);
94
98
104void rtc_configure_callback(rtc_cb_t callback);
void rtc_disable_alarm_interrupt(void)
Disables the alarm callback.
Definition rtc.c:111
-
void rtc_set_date_time(rtc_date_time date_time)
Sets the date and time.
Definition rtc.c:79
+
void rtc_set_date_time(rtc_date_time_t date_time)
Sets the date and time.
Definition rtc.c:79
bool rtc_is_enabled(void)
Checks if the RTC is enabled.
Definition rtc.c:37
+
rtc_date_time_t rtc_get_date_time(void)
Returns the date and time.
Definition rtc.c:86
+
void rtc_enable_alarm_interrupt(rtc_date_time_t alarm_time, rtc_alarm_match_t mask)
Enables the alarm interrupt.
Definition rtc.c:98
void rtc_configure_callback(rtc_cb_t callback)
Configures the RTC alarm callback.
Definition rtc.c:107
void rtc_enable(void)
Enables the RTC.
Definition rtc.c:73
void rtc_init(void)
Initializes the RTC.
Definition rtc.c:49
-
void rtc_enable_alarm_interrupt(rtc_date_time alarm_time, rtc_alarm_match mask)
Enables the alarm interrupt.
Definition rtc.c:98
-
rtc_date_time rtc_get_date_time(void)
Returns the date and time.
Definition rtc.c:86
-
Definition rtc.h:36
+
Definition rtc.h:36
rtc_date_time rtc_get_date_time rtc_date_time_t rtc_get_date_time ( void  )(rtc_date_time rtc_date_time_t  date_time)
- - - + - - + - - + - +

Data Fields

+
Sercom * sercom
 
+
 
uint32_t clock_enable_mask
 
+
 
uint8_t gclk_id
 
+
 
uint8_t interrupt_line
 
 

The documentation for this struct was generated from the following file:
  • common/system.h
  • diff --git a/struct_t_c___instance___details.html b/structtc__instance__details__t.html similarity index 78% rename from struct_t_c___instance___details.html rename to structtc__instance__details__t.html index 8ee7383..bc7fbb3 100644 --- a/struct_t_c___instance___details.html +++ b/structtc__instance__details__t.html @@ -5,7 +5,7 @@ -gossamer: TC_Instance_Details Struct Reference +gossamer: tc_instance_details_t Struct Reference @@ -72,21 +72,21 @@
    -
    TC_Instance_Details Struct Reference
    +
    tc_instance_details_t Struct Reference
    - - - + - - + - +

    Data Fields

    +
    Tc * tc
     
    +
     
    uint32_t clock_enable_mask
     
    +
     
    uint8_t gclk_id
     
     

    The documentation for this struct was generated from the following file:
    • common/system.h
    • diff --git a/struct_t_c_c___instance___details.html b/structtcc__instance__details__t.html similarity index 78% rename from struct_t_c_c___instance___details.html rename to structtcc__instance__details__t.html index 79864c4..3a4284d 100644 --- a/struct_t_c_c___instance___details.html +++ b/structtcc__instance__details__t.html @@ -5,7 +5,7 @@ -gossamer: TCC_Instance_Details Struct Reference +gossamer: tcc_instance_details_t Struct Reference @@ -72,21 +72,21 @@
      -
      TCC_Instance_Details Struct Reference
      +
      tcc_instance_details_t Struct Reference
      - - - + - - + - +

      Data Fields

      +
      Tcc * tcc
       
      +
       
      uint32_t clock_enable_mask
       
      +
       
      uint8_t gclk_id
       
       

      The documentation for this struct was generated from the following file: