diff --git a/annotated.html b/annotated.html index bd6ae1e..45ece97 100644 --- a/annotated.html +++ b/annotated.html @@ -77,10 +77,10 @@
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. | |
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 } |
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
I2CResult i2c_read | +i2c_result_t i2c_read | ( | uint8_t | address, | @@ -295,14 +295,14 @@
I2CResult i2c_read_instance | +i2c_result_t i2c_read_instance | ( | uint8_t | sercom, | @@ -346,14 +346,14 @@
I2CResult i2c_write | +i2c_result_t i2c_write | ( | uint8_t | address, | @@ -390,14 +390,14 @@
I2CResult i2c_write_instance | +i2c_result_t i2c_write_instance | ( | uint8_t | sercom, | 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 @@ - + - + - + @@ -121,21 +121,21 @@ - + - + +
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 } |
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_time | The time that you wish to match. The date is currently ignored. |
mask | One of the values in rtc_alarm_match indicating which values to check. |
mask | One of the values in rtc_alarm_match_t indicating which values to check. |
rtc_date_time rtc_get_date_time | +rtc_date_time_t rtc_get_date_time | ( | void | ) | @@ -232,8 +232,8 @@( | -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 |
Data Fields | |
+ | |
Tc * | tc |
+ | |
uint32_t | clock_enable_mask |
+ | |
uint8_t | gclk_id |
Data Fields | |
+ | |
Tcc * | tcc |
+ | |
uint32_t | clock_enable_mask |
+ | |
uint8_t | gclk_id |
Data Structures | |
struct | TC_Instance_Details |
struct | tc_instance_details_t |
struct | TCC_Instance_Details |
struct | tcc_instance_details_t |
struct | SERCOM_Instance_Details |
struct | sercom_instance_details_t |
@@ -120,24 +120,24 @@ |
Variables | |
-const TC_Instance_Details | TC_Peripherals [] |
+const tc_instance_details_t | TC_Peripherals [] |
const uint8_t | Num_TC_Instances |
const uint8_t | TC_First_Index |
-const TCC_Instance_Details | TCC_Peripherals [] |
+const tcc_instance_details_t | TCC_Peripherals [] |
const uint8_t | Num_TCC_Instances |
-const SERCOM_Instance_Details | SERCOM_Peripherals [] |
+const sercom_instance_details_t | SERCOM_Peripherals [] |
const uint8_t | Num_SERCOM_Instances |