move components to SDK dir

This commit is contained in:
Shuanglei Tao
2025-03-03 09:06:26 +08:00
parent 20d1297e57
commit f4f4c9e60d
1021 changed files with 58 additions and 35059 deletions

View File

@@ -0,0 +1,296 @@
/**
* Copyright (c) 2015 - 2017, Nordic Semiconductor ASA
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form, except as embedded into a Nordic
* Semiconductor ASA integrated circuit in a product or a software update for
* such product, must reproduce the above copyright notice, this list of
* conditions and the following disclaimer in the documentation and/or other
* materials provided with the distribution.
*
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* 4. This software, with or without modification, must only be used with a
* Nordic Semiconductor ASA integrated circuit.
*
* 5. Any software provided in binary form under this license must not be reverse
* engineered, decompiled, modified and/or disassembled.
*
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
#include "sdk_common.h"
#if NRF_MODULE_ENABLED(APP_GPIOTE)
#include "app_gpiote.h"
#include "nrf_drv_gpiote.h"
#include "nrf_bitmask.h"
#define MODULE_INITIALIZED (mp_users != NULL) /**< Macro designating whether the module has been initialized properly. */
/**@brief GPIOTE user type. */
typedef struct
{
uint32_t pins_mask[GPIO_COUNT]; /**< Mask defining which pins user wants to monitor. */
uint32_t pins_low_to_high_mask[GPIO_COUNT]; /**< Mask defining which pins will generate events to this user when toggling low->high. */
uint32_t pins_high_to_low_mask[GPIO_COUNT]; /**< Mask defining which pins will generate events to this user when toggling high->low. */
uint32_t sense_high_pins[GPIO_COUNT]; /**< Mask defining which pins are configured to generate GPIOTE interrupt on transition to high level. */
app_gpiote_event_handler_t event_handler; /**< Pointer to function to be executed when an event occurs. */
bool enabled; /**< Flag indicating whether user is enabled. */
} gpiote_user_t;
STATIC_ASSERT(sizeof(gpiote_user_t) <= GPIOTE_USER_NODE_SIZE);
STATIC_ASSERT(sizeof(gpiote_user_t) % 4 == 0);
static uint8_t m_user_array_size; /**< Size of user array. */
static uint8_t m_user_count; /**< Number of registered users. */
static gpiote_user_t * mp_users = NULL; /**< Array of GPIOTE users. */
static uint32_t m_pins[GPIO_COUNT]; /**< Mask of initialized pins. */
static uint32_t m_last_pins_state[GPIO_COUNT]; /**< Most recent state of pins. */
void gpiote_handler(nrf_drv_gpiote_pin_t pin, nrf_gpiote_polarity_t action)
{
int i;
uint32_t pin_mask[GPIO_COUNT] = {0};
uint32_t empty_pin_mask[GPIO_COUNT] = {0};
nrf_bitmask_bit_set(pin, pin_mask);
bool hitolo = nrf_bitmask_bit_is_set(pin, m_last_pins_state);
nrf_gpio_ports_read(0, GPIO_COUNT, m_last_pins_state);
for (i = 0; i < m_user_count; i++)
{
if (mp_users[i].enabled && nrf_bitmask_bit_is_set(pin, mp_users[i].pins_mask))
{
if (
nrf_bitmask_bit_is_set(pin, mp_users[i].pins_high_to_low_mask)
&& hitolo)
{
mp_users[i].event_handler(empty_pin_mask,pin_mask);
}
else if (
nrf_bitmask_bit_is_set(pin, mp_users[i].pins_low_to_high_mask)
&& !hitolo)
{
mp_users[i].event_handler(pin_mask,empty_pin_mask);
}
}
}
}
uint32_t app_gpiote_init(uint8_t max_users, void * p_buffer)
{
uint32_t ret_code = NRF_SUCCESS;
if (p_buffer == NULL)
{
return NRF_ERROR_INVALID_PARAM;
}
// Check that buffer is correctly aligned.
if (!is_word_aligned(p_buffer))
{
return NRF_ERROR_INVALID_PARAM;
}
// Initialize file globals.
mp_users = (gpiote_user_t *)p_buffer;
m_user_array_size = max_users;
m_user_count = 0;
memset(m_pins,0, sizeof(m_pins));
memset(mp_users, 0, m_user_array_size * sizeof(gpiote_user_t));
if (nrf_drv_gpiote_is_init()==false)
{
ret_code = nrf_drv_gpiote_init();
}
return ret_code;
}
uint32_t app_gpiote_user_register(app_gpiote_user_id_t * p_user_id,
uint32_t const * p_pins_low_to_high_mask,
uint32_t const * p_pins_high_to_low_mask,
app_gpiote_event_handler_t event_handler)
{
uint32_t user_pin_mask[GPIO_COUNT];
uint32_t ret_val = NRF_SUCCESS;
// Check state and parameters.
VERIFY_MODULE_INITIALIZED();
if (event_handler == NULL)
{
return NRF_ERROR_INVALID_PARAM;
}
if (m_user_count >= m_user_array_size)
{
return NRF_ERROR_NO_MEM;
}
nrf_bitmask_masks_or(p_pins_low_to_high_mask, p_pins_high_to_low_mask,
user_pin_mask, sizeof(user_pin_mask));
// Allocate new user.
memcpy(mp_users[m_user_count].pins_mask,
user_pin_mask, sizeof(mp_users[m_user_count].pins_mask));
memcpy(mp_users[m_user_count].pins_low_to_high_mask,
p_pins_low_to_high_mask, sizeof(mp_users[m_user_count].pins_low_to_high_mask));
memcpy(mp_users[m_user_count].pins_high_to_low_mask,
p_pins_high_to_low_mask, sizeof(mp_users[m_user_count].pins_high_to_low_mask));
mp_users[m_user_count].event_handler = event_handler;
mp_users[m_user_count].enabled = false;
*p_user_id = m_user_count++;
uint32_t i;
const nrf_drv_gpiote_in_config_t config = GPIOTE_CONFIG_IN_SENSE_TOGGLE(false);
uint32_t num_of_pins = NUMBER_OF_PINS ;
for (i = 0; i < num_of_pins; i++)
{
if (nrf_bitmask_bit_is_set(i, user_pin_mask) &&
!nrf_bitmask_bit_is_set(i, m_pins))
{
ret_val = nrf_drv_gpiote_in_init(i, &config, gpiote_handler);
VERIFY_SUCCESS(ret_val);
nrf_bitmask_bit_set(i, m_pins);
}
}
return ret_val;
}
__STATIC_INLINE uint32_t error_check(app_gpiote_user_id_t user_id)
{
// Check state and parameters.
VERIFY_MODULE_INITIALIZED();
if (user_id >= m_user_count)
{
return NRF_ERROR_INVALID_PARAM;
}
return NRF_SUCCESS;
}
/**
* @brief Function for enabling event on pin (if not yet enabled) or disabling the event if no other
* user requires it.
*
* @param pin Pin to enable
* @param enable If true function will attempt to enable the pin else it will attempt to disable it.
*/
static void pin_event_enable(uint32_t pin, bool enable)
{
uint32_t i;
bool enabled = false;
//search if any user already enabled given pin
for (i = 0; i < m_user_count; i++)
{
if (mp_users[i].enabled &&
nrf_bitmask_bit_is_set(pin, mp_users[i].pins_mask))
{
enabled = true;
break;
}
}
if (!enabled)
{
if (enable)
{
nrf_gpio_ports_read(0, GPIO_COUNT, m_last_pins_state);
nrf_drv_gpiote_in_event_enable(pin, true);
}
else
{
nrf_drv_gpiote_in_event_disable(pin);
}
}
}
/**
* @brief Function for enabling or disabling events for pins used by the user.
*
* Function will enable pin events only if they are not yet enabled. Function will disable pin
* events only if there is no other enabled user that is using them.
*
* @param user_id User id.
* @param enable If true function will attempt to enable the pin else it will attempt to disable it.
*/
static uint32_t user_enable(app_gpiote_user_id_t user_id, bool enable)
{
uint32_t ret_code = error_check(user_id);
if (ret_code == NRF_SUCCESS)
{
uint32_t i;
for (i = 0; i < NUMBER_OF_PINS; i++)
{
if (nrf_bitmask_bit_is_set(i, mp_users[user_id].pins_mask))
{
pin_event_enable(i, enable);
}
}
}
return ret_code;
}
uint32_t app_gpiote_user_enable(app_gpiote_user_id_t user_id)
{
uint32_t ret_code = NRF_SUCCESS;
if (mp_users[user_id].enabled == false)
{
ret_code = user_enable(user_id, true);
VERIFY_SUCCESS(ret_code);
mp_users[user_id].enabled = true;
return ret_code;
}
else
{
return ret_code;
}
}
uint32_t app_gpiote_user_disable(app_gpiote_user_id_t user_id)
{
uint32_t ret_code = NRF_SUCCESS;
if (mp_users[user_id].enabled)
{
mp_users[user_id].enabled = false;
ret_code = user_enable(user_id, false);
}
return ret_code;
}
uint32_t app_gpiote_pins_state_get(app_gpiote_user_id_t user_id, uint32_t * p_pins)
{
gpiote_user_t * p_user;
uint32_t ret_code = error_check(user_id);
if (ret_code == NRF_SUCCESS)
{
p_user = &mp_users[user_id];
nrf_gpio_ports_read(0, GPIO_COUNT, p_pins);
nrf_bitmask_masks_and(p_pins, p_user->pins_mask, p_pins, sizeof(p_user->pins_mask));
}
return ret_code;
}
#endif //NRF_MODULE_ENABLED(APP_GPIOTE)

View File

@@ -0,0 +1,206 @@
/**
* Copyright (c) 2012 - 2017, Nordic Semiconductor ASA
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form, except as embedded into a Nordic
* Semiconductor ASA integrated circuit in a product or a software update for
* such product, must reproduce the above copyright notice, this list of
* conditions and the following disclaimer in the documentation and/or other
* materials provided with the distribution.
*
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* 4. This software, with or without modification, must only be used with a
* Nordic Semiconductor ASA integrated circuit.
*
* 5. Any software provided in binary form under this license must not be reverse
* engineered, decompiled, modified and/or disassembled.
*
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
/** @file
*
* @defgroup app_gpiote GPIOTE Handler
* @{
* @ingroup app_common
*
* @brief GPIOTE handler module.
*
* @details The GPIOTE handler allows several modules ("users") to share the GPIOTE interrupt,
* each user defining a set of pins able to generate events to the user.
* When a GPIOTE interrupt occurs, the GPIOTE interrupt handler will call the event handler
* of each user for which at least one of the pins generated an event.
*
* The GPIOTE users are responsible for configuring all their corresponding pins, except
* the SENSE field, which should be initialized to GPIO_PIN_CNF_SENSE_Disabled.
* The SENSE field will be updated by the GPIOTE module when it is enabled or disabled,
* and also while it is enabled.
*
* The module specifies on which pins events should be generated if the pin(s) goes
* from low->high or high->low or both directions.
*
* @note Even if the application is using the @ref app_scheduler, the GPIOTE event handlers will
* be called directly from the GPIOTE interrupt handler.
*
* @warning If multiple users registers for the same pins the behavior for those pins are undefined.
*/
#ifndef APP_GPIOTE_H__
#define APP_GPIOTE_H__
#include <stdint.h>
#include <stdbool.h>
#include "nrf.h"
#include "app_error.h"
#include "app_util.h"
#ifdef __cplusplus
extern "C" {
#endif
#define GPIOTE_USER_NODE_SIZE ((4*sizeof(uint32_t)*GPIO_COUNT)+8) /**< Size of app_gpiote.gpiote_user_t (only for use inside APP_GPIOTE_BUF_SIZE()). */
/**@brief Compute number of bytes required to hold the GPIOTE data structures.
*
* @param[in] MAX_USERS Maximum number of GPIOTE users.
*
* @retval Required buffer size (in bytes).
*/
#define APP_GPIOTE_BUF_SIZE(MAX_USERS) ((MAX_USERS) * GPIOTE_USER_NODE_SIZE)
typedef uint8_t app_gpiote_user_id_t;
/**@brief GPIOTE event handler type. */
typedef void (*app_gpiote_event_handler_t)(uint32_t const * p_event_pins_low_to_high,
uint32_t const * p_event_pins_high_to_low);
/**@brief GPIOTE input event handler type. */
typedef void (*app_gpiote_input_event_handler_t)(void);
/**@brief Macro for initializing the GPIOTE module.
*
* @details It will handle dimensioning and allocation of the memory buffer required by the module,
* making sure that the buffer is correctly aligned.
*
* @param[in] MAX_USERS Maximum number of GPIOTE users.
*
* @note Since this macro allocates a buffer, it must only be called once (it is OK to call it
* several times as long as it is from the same location, e.g. to do a reinitialization).
*/
/*lint -emacro(506, APP_GPIOTE_INIT) */ /* Suppress "Constant value Boolean */
#define APP_GPIOTE_INIT(MAX_USERS) \
do \
{ \
static uint32_t app_gpiote_buf[CEIL_DIV(APP_GPIOTE_BUF_SIZE(MAX_USERS), sizeof(uint32_t))];\
uint32_t ERR_CODE = app_gpiote_init((MAX_USERS), app_gpiote_buf); \
APP_ERROR_CHECK(ERR_CODE); \
} while (0)
/**@brief Function for initializing the GPIOTE module.
*
* @note Normally initialization should be done using the APP_GPIOTE_INIT() macro, as that will
* allocate the buffer needed by the GPIOTE module (including aligning the buffer correctly).
*
* @param[in] max_users Maximum number of GPIOTE users.
* @param[in] p_buffer Pointer to memory buffer for internal use in the app_gpiote
* module. The size of the buffer can be computed using the
* APP_GPIOTE_BUF_SIZE() macro. The buffer must be aligned to
* a 4 byte boundary.
*
* @retval NRF_SUCCESS Successful initialization.
* @retval NRF_ERROR_INVALID_PARAM Invalid parameter (buffer not aligned to a 4 byte
* boundary).
*/
uint32_t app_gpiote_init(uint8_t max_users, void * p_buffer);
/**@brief Function for registering a GPIOTE user.
*
* @param[out] p_user_id Id for the new GPIOTE user.
* @param[in] p_pins_low_to_high_mask Pointer to word array with mask defining which pins
* will generate events to this user when state is changed
* from low->high. Size of array depends on number of ports
* in the device.
* @param[in] p_pins_high_to_low_mask Pointer to word array with mask defining which pins
* will generate events to this user when state is changed
* from high->low. Size of array depends on number of ports
* in the device.
* @param[in] event_handler Pointer to function to be executed when an event occurs.
*
* @retval NRF_SUCCESS Successful initialization.
* @retval NRF_ERROR_INVALID_PARAM Invalid parameter (buffer not aligned to a 4 byte boundary).
* @retval NRF_ERROR_INALID_STATE If @ref app_gpiote_init has not been called on the GPIOTE
* module.
* @retval NRF_ERROR_NO_MEM Returned if the application tries to register more users
* than defined when the GPIOTE module was initialized in
* @ref app_gpiote_init.
*/
uint32_t app_gpiote_user_register(app_gpiote_user_id_t * p_user_id,
uint32_t const * p_pins_low_to_high_mask,
uint32_t const * p_pins_high_to_low_mask,
app_gpiote_event_handler_t event_handler);
/**@brief Function for informing the GPIOTE module that the specified user wants to use the GPIOTE module.
*
* @param[in] user_id Id of user to enable.
*
* @retval NRF_SUCCESS On success.
* @retval NRF_ERROR_INVALID_PARAM Invalid user_id provided, No a valid user.
* @retval NRF_ERROR_INALID_STATE If @ref app_gpiote_init has not been called on the GPIOTE
* module.
*/
uint32_t app_gpiote_user_enable(app_gpiote_user_id_t user_id);
/**@brief Function for informing the GPIOTE module that the specified user is done using the GPIOTE module.
*
* @param[in] user_id Id of user to enable.
*
* @retval NRF_SUCCESS On success.
* @retval NRF_ERROR_INVALID_PARAM Invalid user_id provided, No a valid user.
* @retval NRF_ERROR_INALID_STATE If @ref app_gpiote_init has not been called on the GPIOTE
* module.
*/
uint32_t app_gpiote_user_disable(app_gpiote_user_id_t user_id);
/**@brief Function for getting the state of the pins which are registered for the specified user.
*
* @param[in] user_id Id of user to check.
* @param[out] p_pins Pointer to array of words with bit mask corresponding to the pins
* configured to generate events to the specified user. All bits
* corresponding to pins in the state 'high' will have value '1',
* all others will have value '0'. Size of array depends on number
* of ports in the device.
*
* @retval NRF_SUCCESS On success.
* @retval NRF_ERROR_INVALID_PARAM Invalid user_id provided, No a valid user.
* @retval NRF_ERROR_INALID_STATE If @ref app_gpiote_init has not been called on the GPIOTE
* module.
*/
uint32_t app_gpiote_pins_state_get(app_gpiote_user_id_t user_id, uint32_t * p_pins);
#ifdef __cplusplus
}
#endif
#endif // APP_GPIOTE_H__
/** @} */