From 7626f97ab3d30e970be40f07172a789bf947f0d3 Mon Sep 17 00:00:00 2001 From: joeycastillo Date: Wed, 18 Sep 2024 18:21:16 +0000 Subject: [PATCH] deploy: 9296c4055c35049fc29cb51c3bc1f7f8a4cf14df --- adc_8h.html | 12 ++++---- adc_8h_source.html | 10 +++---- eic_8h.html | 65 ++++++++++++++++++++-------------------- eic_8h_source.html | 24 +++++++-------- globals.html | 12 ++++---- globals_func.html | 12 ++++---- hal__gpio_8h_source.html | 4 +-- search/all_2.js | 2 +- search/all_6.js | 10 +++---- search/functions_1.js | 2 +- search/functions_3.js | 10 +++---- 11 files changed, 82 insertions(+), 81 deletions(-) diff --git a/adc_8h.html b/adc_8h.html index 5f44ab8..b70c330 100644 --- a/adc_8h.html +++ b/adc_8h.html @@ -99,9 +99,9 @@ void adc_set_sampling_length (uint8_t length)  Sets the sampling length for the ADC.
  -uint16_t adc_get_analog_value (uint16_t pin) - Gets the analog value on the given ADC pin.
-  +uint16_t adc_get_analog_value (uint8_t pin) + Gets the analog value on the given ADC pin.
+  uint16_t adc_get_analog_value_for_channel (uint8_t channel)  Gets the analog value on the given ADC channel.
  @@ -113,8 +113,8 @@

Detailed Description

Analog to Digital Converter.

Function Documentation

- -

◆ adc_get_analog_value()

+ +

◆ adc_get_analog_value()

@@ -122,7 +122,7 @@

uint16_t adc_get_analog_value ( - uint16_t  + uint8_t  pin) diff --git a/adc_8h_source.html b/adc_8h_source.html index dd00262..7edc783 100644 --- a/adc_8h_source.html +++ b/adc_8h_source.html @@ -119,17 +119,17 @@
58
68void adc_set_sampling_length(uint8_t length);
69
-
76uint16_t adc_get_analog_value(uint16_t pin);
+
76uint16_t adc_get_analog_value(uint8_t pin);
77
83uint16_t adc_get_analog_value_for_channel(uint8_t channel);
84
88void adc_disable(void);
adc_set_sampling_length
void adc_set_sampling_length(uint8_t length)
Sets the sampling length for the ADC.
Definition adc.c:75
adc_get_analog_value_for_channel
uint16_t adc_get_analog_value_for_channel(uint8_t channel)
Gets the analog value on the given ADC channel.
Definition adc.c:81
-
adc_init
void adc_init(void)
Initializes the ADC peripheral, but does not enable it.
Definition adc.c:103
-
adc_get_analog_value
uint16_t adc_get_analog_value(uint16_t pin)
Gets the analog value on the given ADC pin.
Definition adc.c:93
-
adc_enable
void adc_enable(void)
Enables the ADC peripheral.
Definition adc.c:184
-
adc_disable
void adc_disable(void)
Disables the ADC peripheral.
Definition adc.c:191
+
adc_init
void adc_init(void)
Initializes the ADC peripheral, but does not enable it.
Definition adc.c:102
+
adc_enable
void adc_enable(void)
Enables the ADC peripheral.
Definition adc.c:183
+
adc_disable
void adc_disable(void)
Disables the ADC peripheral.
Definition adc.c:190
+
adc_get_analog_value
uint16_t adc_get_analog_value(uint8_t pin)
Gets the analog value on the given ADC pin.
Definition adc.c:93

diff --git a/eic_8h.html b/eic_8h.html index f765646..3c3d13d 100644 --- a/eic_8h.html +++ b/eic_8h.html @@ -119,21 +119,21 @@ void eic_enable (void)  Enables the external interrupt controller.
  -int8_t eic_configure_pin (const uint16_t pin, eic_interrupt_trigger trigger) - Configures an external interrupt on one of the external interrupt pins.
-  -bool eic_enable_interrupt (const uint16_t pin) - Enables an interrupt on the given interrupt channel.
-  -bool eic_disable_interrupt (const uint16_t pin) - Disables the interrupt on the given interrupt channel.
-  -bool eic_enable_event (const uint16_t pin) - Enables an interrupt on the given interrupt channel.
-  -bool eic_disable_event (const uint16_t pin) - Disables the interrupt on the given interrupt channel.
-  +int8_t eic_configure_pin (const uint8_t pin, eic_interrupt_trigger 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.
+  +bool eic_disable_interrupt (const uint8_t pin) + Disables the interrupt on the given interrupt channel.
+  +bool eic_enable_event (const uint8_t pin) + Enables an interrupt on the given interrupt channel.
+  +bool eic_disable_event (const uint8_t pin) + Disables the interrupt on the given interrupt channel.
+  void eic_configure_callback (eic_cb_t callback)  Configures an external interrupt callback.
  @@ -172,8 +172,8 @@

-

◆ eic_configure_pin()

+ +

◆ eic_configure_pin()

@@ -181,7 +181,7 @@

int8_t eic_configure_pin ( - const uint16_t  + const uint8_t  pin, @@ -199,20 +199,21 @@

Configures an external interrupt on one of the external interrupt pins.

-

This function configures the interrupt channel with the specified trigger, but it does not set pin direction, mux or pull; you must set up the pin yourself. This function also does not enable an interrupt or event generation. You must call eic_enable_interrupt() or eic_enable_event() to either wake the processor or generate an event for a peripheral.

Parameters
+

This function configures the interrupt channel with the specified trigger, but it does not set pin direction, mux or pull; you must set up the pin yourself. This function also does not enable an interrupt or event generation. You must call eic_enable_interrupt() or eic_enable_event() to either wake the processor or generate an event for a peripheral.

Parameters
- +
pinThe external interrupt pin you wish to configure
pinThe external interrupt pin you wish to configure — use HAL_GPIO_xxx_PIN() macro.
triggerThe condition on which you wish to trigger: rising, falling or both.
Returns
the EIC channel number associated with the pin, or -1 if the pin is not an interrupt pin.
Note
Be sure to check your pin multiplexing table to ensure that you do not have multiple pins assigned to the same interrupt channel. Also note that the NMI pin is not currently supported.
+

FIXME: Should we have macros for this that accept a port / pin?

- -

◆ eic_disable_event()

+ +

◆ eic_disable_event()

@@ -220,7 +221,7 @@

bool eic_disable_event ( - const uint16_t  + const uint8_t  pin) @@ -237,8 +238,8 @@

-

◆ eic_disable_interrupt()

+ +

◆ eic_disable_interrupt()

@@ -246,7 +247,7 @@

bool eic_disable_interrupt ( - const uint16_t  + const uint8_t  pin) @@ -263,8 +264,8 @@

-

◆ eic_enable_event()

+ +

◆ eic_enable_event()

@@ -272,7 +273,7 @@

bool eic_enable_event ( - const uint16_t  + const uint8_t  pin) @@ -289,8 +290,8 @@

-

◆ eic_enable_interrupt()

+ +

◆ eic_enable_interrupt()

@@ -298,7 +299,7 @@

bool eic_enable_interrupt ( - const uint16_t  + const uint8_t  pin) diff --git a/eic_8h_source.html b/eic_8h_source.html index 4f29895..dc4e651 100644 --- a/eic_8h_source.html +++ b/eic_8h_source.html @@ -127,28 +127,28 @@
47
50void eic_enable(void);
51
-
63int8_t eic_configure_pin(const uint16_t pin, eic_interrupt_trigger trigger);
+
63int8_t eic_configure_pin(const uint8_t pin, eic_interrupt_trigger trigger);
64
-
68bool eic_enable_interrupt(const uint16_t pin);
+
68bool eic_enable_interrupt(const uint8_t pin);
69
-
73bool eic_disable_interrupt(const uint16_t pin);
+
73bool eic_disable_interrupt(const uint8_t pin);
74
-
78bool eic_enable_event(const uint16_t pin);
+
78bool eic_enable_event(const uint8_t pin);
79
-
83bool eic_disable_event(const uint16_t pin);
+
83bool eic_disable_event(const uint8_t pin);
84
91void eic_configure_callback(eic_cb_t callback);
92
95void eic_disable(void);
-
eic_disable_event
bool eic_disable_event(const uint16_t pin)
Disables the interrupt on the given interrupt channel.
Definition eic.c:189
-
eic_configure_callback
void eic_configure_callback(eic_cb_t callback)
Configures an external interrupt callback.
Definition eic.c:218
+
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_disable_interrupt
bool eic_disable_interrupt(const uint16_t pin)
Disables the interrupt on the given interrupt channel.
Definition eic.c:149
-
eic_enable_event
bool eic_enable_event(const uint16_t pin)
Enables an interrupt on the given interrupt channel.
Definition eic.c:170
-
eic_configure_pin
int8_t eic_configure_pin(const uint16_t pin, eic_interrupt_trigger trigger)
Configures an external interrupt on one of the external interrupt pins.
Definition eic.c:99
-
eic_disable
void eic_disable(void)
Disables the external interrupt controller.
Definition eic.c:208
+
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_init
void eic_init(void)
Initializes the external interrupt controller, but does not enable it.
Definition eic.c:62
-
eic_enable_interrupt
bool eic_enable_interrupt(const uint16_t pin)
Enables an interrupt on the given interrupt channel.
Definition eic.c:128
+
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 a2acd16..c3b9b2f 100644 --- a/globals.html +++ b/globals.html @@ -81,7 +81,7 @@

- _ -

    - a -

    • adc_disable() : adc.h
    • adc_enable() : adc.h
      • -
    • adc_get_analog_value() : adc.h
      • +
    • adc_get_analog_value() : adc.h
    • adc_get_analog_value_for_channel() : adc.h
    • adc_init() : adc.h
    • adc_set_sampling_length() : adc.h
      • @@ -105,13 +105,13 @@

      - d -

        - e -

        • eic_configure_callback() : eic.h
          • -
        • eic_configure_pin() : eic.h
          • +
        • eic_configure_pin() : eic.h
        • eic_disable() : eic.h
          • -
        • eic_disable_event() : eic.h
          • -
        • eic_disable_interrupt() : eic.h
          • +
        • eic_disable_event() : eic.h
          • +
        • eic_disable_interrupt() : eic.h
        • eic_enable() : eic.h
          • -
        • eic_enable_event() : eic.h
          • -
        • eic_enable_interrupt() : eic.h
          • +
        • eic_enable_event() : eic.h
          • +
        • eic_enable_interrupt() : eic.h
        • eic_init() : eic.h
        • eic_interrupt_trigger : eic.h
        diff --git a/globals_func.html b/globals_func.html index b9975fb..c41cdbd 100644 --- a/globals_func.html +++ b/globals_func.html @@ -81,7 +81,7 @@

        - _ -

          - a -

          • adc_disable() : adc.h
          • adc_enable() : adc.h
            • -
          • adc_get_analog_value() : adc.h
            • +
          • adc_get_analog_value() : adc.h
          • adc_get_analog_value_for_channel() : adc.h
          • adc_init() : adc.h
          • adc_set_sampling_length() : adc.h
            • @@ -105,13 +105,13 @@

            - d -

              - e -

              • eic_configure_callback() : eic.h
                • -
              • eic_configure_pin() : eic.h
                • +
              • eic_configure_pin() : eic.h
              • eic_disable() : eic.h
                • -
              • eic_disable_event() : eic.h
                • -
              • eic_disable_interrupt() : eic.h
                • +
              • eic_disable_event() : eic.h
                • +
              • eic_disable_interrupt() : eic.h
              • eic_enable() : eic.h
                • -
              • eic_enable_event() : eic.h
                • -
              • eic_enable_interrupt() : eic.h
                • +
              • eic_enable_event() : eic.h
                • +
              • eic_enable_interrupt() : eic.h
              • eic_init() : eic.h
              diff --git a/hal__gpio_8h_source.html b/hal__gpio_8h_source.html index 746aaea..e469936 100644 --- a/hal__gpio_8h_source.html +++ b/hal__gpio_8h_source.html @@ -226,9 +226,9 @@
              145 (void)HAL_GPIO_##name##_pmuxdis; \
              146 } \
              147 \
              -
              148 static inline uint16_t HAL_GPIO_##name##_pin(void) \
              +
              148 static inline uint8_t HAL_GPIO_##name##_pin(void) \
              149 { \
              -
              150 return ((HAL_GPIO_PORT##port << 8) | pin); \
              +
              150 return ((HAL_GPIO_PORT##port << 5) | (pin & 0x1f)); \
              151 (void)HAL_GPIO_##name##_pin; \
              152 } \
              153 \
              diff --git a/search/all_2.js b/search/all_2.js index 6b68199..23c339e 100644 --- a/search/all_2.js +++ b/search/all_2.js @@ -6,7 +6,7 @@ var searchData= ['adc_2eh_3',['adc.h',['../adc_8h.html',1,'']]], ['adc_5fdisable_4',['adc_disable',['../adc_8h.html#a3b4b977d0665b5346849f3b892ac5106',1,'adc.c']]], ['adc_5fenable_5',['adc_enable',['../adc_8h.html#a3afdea3b7c9b91013c270f1a1a669782',1,'adc.c']]], - ['adc_5fget_5fanalog_5fvalue_6',['adc_get_analog_value',['../adc_8h.html#a2c8f49eff87c1a55de3b11afe59cae37',1,'adc.c']]], + ['adc_5fget_5fanalog_5fvalue_6',['adc_get_analog_value',['../adc_8h.html#a96ce001b81ec65219abcb7e4a583f55c',1,'adc.c']]], ['adc_5fget_5fanalog_5fvalue_5ffor_5fchannel_7',['adc_get_analog_value_for_channel',['../adc_8h.html#a200744370e2a8505c3dead71aff1c2dc',1,'adc.c']]], ['adc_5finit_8',['adc_init',['../adc_8h.html#a2b815e6730e8723a6d1d06d9ef8f31c0',1,'adc.c']]], ['adc_5fset_5fsampling_5flength_9',['adc_set_sampling_length',['../adc_8h.html#a1b33d0d9bd2841354f016f8c64be3e15',1,'adc.c']]], diff --git a/search/all_6.js b/search/all_6.js index 4435220..9ddb4be 100644 --- a/search/all_6.js +++ b/search/all_6.js @@ -2,13 +2,13 @@ var searchData= [ ['eic_2eh_0',['eic.h',['../eic_8h.html',1,'']]], ['eic_5fconfigure_5fcallback_1',['eic_configure_callback',['../eic_8h.html#a5695270545c3f5b6a24682447108e6cd',1,'eic.c']]], - ['eic_5fconfigure_5fpin_2',['eic_configure_pin',['../eic_8h.html#ab61365e6306709c1d61e5a120aa31e7c',1,'eic.c']]], + ['eic_5fconfigure_5fpin_2',['eic_configure_pin',['../eic_8h.html#a2a5edab4766fd37fafd1ef2f8dc82702',1,'eic.c']]], ['eic_5fdisable_3',['eic_disable',['../eic_8h.html#abaae85c8706e41bb2cc2b7aa7be956e6',1,'eic.c']]], - ['eic_5fdisable_5fevent_4',['eic_disable_event',['../eic_8h.html#a30614b78372bed46740c1772f1db917a',1,'eic.c']]], - ['eic_5fdisable_5finterrupt_5',['eic_disable_interrupt',['../eic_8h.html#a9162b1b90f614ba7669b2085d1e992ca',1,'eic.c']]], + ['eic_5fdisable_5fevent_4',['eic_disable_event',['../eic_8h.html#a21e4b3925d449c25fe3831b167845161',1,'eic.c']]], + ['eic_5fdisable_5finterrupt_5',['eic_disable_interrupt',['../eic_8h.html#a48015b16099d943fad32302fad6114a1',1,'eic.c']]], ['eic_5fenable_6',['eic_enable',['../eic_8h.html#afd8706ad3219397c91636524d2149eb0',1,'eic.c']]], - ['eic_5fenable_5fevent_7',['eic_enable_event',['../eic_8h.html#ab58e6f907598dcd4c4f8e097093e2a18',1,'eic.c']]], - ['eic_5fenable_5finterrupt_8',['eic_enable_interrupt',['../eic_8h.html#ad74b84a44f944e0135faa9a85899058b',1,'eic.c']]], + ['eic_5fenable_5fevent_7',['eic_enable_event',['../eic_8h.html#ae6a140e7799fec385ff48c97f399b7cf',1,'eic.c']]], + ['eic_5fenable_5finterrupt_8',['eic_enable_interrupt',['../eic_8h.html#a95932a1b8c5442120cd6caa7a5cb0733',1,'eic.c']]], ['eic_5finit_9',['eic_init',['../eic_8h.html#ac66cb10fff656315b12df4248f798c41',1,'eic.c']]], ['eic_5finterrupt_5ftrigger_10',['eic_interrupt_trigger',['../eic_8h.html#a64ab58f4cc1141f8b023f0f96f58f980',1,'eic_interrupt_trigger: eic.h'],['../eic_8h.html#a747988f19d99d6e6bedfb0849e51e43d',1,'eic_interrupt_trigger: eic.h']]] ]; diff --git a/search/functions_1.js b/search/functions_1.js index 3dc457e..0728776 100644 --- a/search/functions_1.js +++ b/search/functions_1.js @@ -2,7 +2,7 @@ var searchData= [ ['adc_5fdisable_0',['adc_disable',['../adc_8h.html#a3b4b977d0665b5346849f3b892ac5106',1,'adc.c']]], ['adc_5fenable_1',['adc_enable',['../adc_8h.html#a3afdea3b7c9b91013c270f1a1a669782',1,'adc.c']]], - ['adc_5fget_5fanalog_5fvalue_2',['adc_get_analog_value',['../adc_8h.html#a2c8f49eff87c1a55de3b11afe59cae37',1,'adc.c']]], + ['adc_5fget_5fanalog_5fvalue_2',['adc_get_analog_value',['../adc_8h.html#a96ce001b81ec65219abcb7e4a583f55c',1,'adc.c']]], ['adc_5fget_5fanalog_5fvalue_5ffor_5fchannel_3',['adc_get_analog_value_for_channel',['../adc_8h.html#a200744370e2a8505c3dead71aff1c2dc',1,'adc.c']]], ['adc_5finit_4',['adc_init',['../adc_8h.html#a2b815e6730e8723a6d1d06d9ef8f31c0',1,'adc.c']]], ['adc_5fset_5fsampling_5flength_5',['adc_set_sampling_length',['../adc_8h.html#a1b33d0d9bd2841354f016f8c64be3e15',1,'adc.c']]], diff --git a/search/functions_3.js b/search/functions_3.js index fca5ae4..ef6bbe1 100644 --- a/search/functions_3.js +++ b/search/functions_3.js @@ -1,12 +1,12 @@ var searchData= [ ['eic_5fconfigure_5fcallback_0',['eic_configure_callback',['../eic_8h.html#a5695270545c3f5b6a24682447108e6cd',1,'eic.c']]], - ['eic_5fconfigure_5fpin_1',['eic_configure_pin',['../eic_8h.html#ab61365e6306709c1d61e5a120aa31e7c',1,'eic.c']]], + ['eic_5fconfigure_5fpin_1',['eic_configure_pin',['../eic_8h.html#a2a5edab4766fd37fafd1ef2f8dc82702',1,'eic.c']]], ['eic_5fdisable_2',['eic_disable',['../eic_8h.html#abaae85c8706e41bb2cc2b7aa7be956e6',1,'eic.c']]], - ['eic_5fdisable_5fevent_3',['eic_disable_event',['../eic_8h.html#a30614b78372bed46740c1772f1db917a',1,'eic.c']]], - ['eic_5fdisable_5finterrupt_4',['eic_disable_interrupt',['../eic_8h.html#a9162b1b90f614ba7669b2085d1e992ca',1,'eic.c']]], + ['eic_5fdisable_5fevent_3',['eic_disable_event',['../eic_8h.html#a21e4b3925d449c25fe3831b167845161',1,'eic.c']]], + ['eic_5fdisable_5finterrupt_4',['eic_disable_interrupt',['../eic_8h.html#a48015b16099d943fad32302fad6114a1',1,'eic.c']]], ['eic_5fenable_5',['eic_enable',['../eic_8h.html#afd8706ad3219397c91636524d2149eb0',1,'eic.c']]], - ['eic_5fenable_5fevent_6',['eic_enable_event',['../eic_8h.html#ab58e6f907598dcd4c4f8e097093e2a18',1,'eic.c']]], - ['eic_5fenable_5finterrupt_7',['eic_enable_interrupt',['../eic_8h.html#ad74b84a44f944e0135faa9a85899058b',1,'eic.c']]], + ['eic_5fenable_5fevent_6',['eic_enable_event',['../eic_8h.html#ae6a140e7799fec385ff48c97f399b7cf',1,'eic.c']]], + ['eic_5fenable_5finterrupt_7',['eic_enable_interrupt',['../eic_8h.html#a95932a1b8c5442120cd6caa7a5cb0733',1,'eic.c']]], ['eic_5finit_8',['eic_init',['../eic_8h.html#ac66cb10fff656315b12df4248f798c41',1,'eic.c']]] ];