You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
400 lines
19 KiB
400 lines
19 KiB
/*
|
|
* Copyright (c) 2015 - 2019, 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 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 the copyright holder nor the names of its
|
|
* contributors may be used to endorse or promote products derived from this
|
|
* software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER 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.
|
|
*/
|
|
|
|
#ifndef NRFX_TWIM_H__
|
|
#define NRFX_TWIM_H__
|
|
|
|
#include <nrfx.h>
|
|
#include <hal/nrf_twim.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @defgroup nrfx_twim TWIM driver
|
|
* @{
|
|
* @ingroup nrf_twim
|
|
* @brief Two Wire Interface Master with EasyDMA (TWIM) peripheral driver.
|
|
*/
|
|
|
|
/** @brief Structure for the TWI master driver instance. */
|
|
typedef struct
|
|
{
|
|
NRF_TWIM_Type * p_twim; ///< Pointer to a structure with TWIM registers.
|
|
uint8_t drv_inst_idx; ///< Index of the driver instance. For internal use only.
|
|
} nrfx_twim_t;
|
|
|
|
/** @brief Macro for creating a TWI master driver instance. */
|
|
#define NRFX_TWIM_INSTANCE(id) \
|
|
{ \
|
|
.p_twim = NRFX_CONCAT_2(NRF_TWIM, id), \
|
|
.drv_inst_idx = NRFX_CONCAT_3(NRFX_TWIM, id, _INST_IDX), \
|
|
}
|
|
|
|
#ifndef __NRFX_DOXYGEN__
|
|
enum {
|
|
#if NRFX_CHECK(NRFX_TWIM0_ENABLED)
|
|
NRFX_TWIM0_INST_IDX,
|
|
#endif
|
|
#if NRFX_CHECK(NRFX_TWIM1_ENABLED)
|
|
NRFX_TWIM1_INST_IDX,
|
|
#endif
|
|
#if NRFX_CHECK(NRFX_TWIM2_ENABLED)
|
|
NRFX_TWIM2_INST_IDX,
|
|
#endif
|
|
#if NRFX_CHECK(NRFX_TWIM3_ENABLED)
|
|
NRFX_TWIM3_INST_IDX,
|
|
#endif
|
|
NRFX_TWIM_ENABLED_COUNT
|
|
};
|
|
#endif
|
|
|
|
/** @brief Structure for the TWI master driver instance configuration. */
|
|
typedef struct
|
|
{
|
|
uint32_t scl; ///< SCL pin number.
|
|
uint32_t sda; ///< SDA pin number.
|
|
nrf_twim_frequency_t frequency; ///< TWIM frequency.
|
|
uint8_t interrupt_priority; ///< Interrupt priority.
|
|
bool hold_bus_uninit; ///< Hold pull up state on GPIO pins after uninit.
|
|
} nrfx_twim_config_t;
|
|
|
|
/** @brief TWI master driver instance default configuration. */
|
|
#define NRFX_TWIM_DEFAULT_CONFIG \
|
|
{ \
|
|
.scl = 31, \
|
|
.sda = 31, \
|
|
.frequency = (nrf_twim_frequency_t)NRFX_TWIM_DEFAULT_CONFIG_FREQUENCY, \
|
|
.interrupt_priority = NRFX_TWIM_DEFAULT_CONFIG_IRQ_PRIORITY, \
|
|
.hold_bus_uninit = NRFX_TWIM_DEFAULT_CONFIG_HOLD_BUS_UNINIT, \
|
|
}
|
|
|
|
/** @brief Flag indicating that TX buffer address will be incremented after the transfer. */
|
|
#define NRFX_TWIM_FLAG_TX_POSTINC (1UL << 0)
|
|
/** @brief Flag indicating that RX buffer address will be incremented after the transfer. */
|
|
#define NRFX_TWIM_FLAG_RX_POSTINC (1UL << 1)
|
|
/** @brief Flag indicating that the interrupt after each transfer will be suppressed, and the event handler will not be called. */
|
|
#define NRFX_TWIM_FLAG_NO_XFER_EVT_HANDLER (1UL << 2)
|
|
/** @brief Flag indicating that the transfer will be set up, but not started. */
|
|
#define NRFX_TWIM_FLAG_HOLD_XFER (1UL << 3)
|
|
/** @brief Flag indicating that the transfer will be executed multiple times. */
|
|
#define NRFX_TWIM_FLAG_REPEATED_XFER (1UL << 4)
|
|
/** @brief Flag indicating that the TX transfer will not end with a stop condition. */
|
|
#define NRFX_TWIM_FLAG_TX_NO_STOP (1UL << 5)
|
|
|
|
/** @brief TWI master driver event types. */
|
|
typedef enum
|
|
{
|
|
NRFX_TWIM_EVT_DONE, ///< Transfer completed event.
|
|
NRFX_TWIM_EVT_ADDRESS_NACK, ///< Error event: NACK received after sending the address.
|
|
NRFX_TWIM_EVT_DATA_NACK ///< Error event: NACK received after sending a data byte.
|
|
} nrfx_twim_evt_type_t;
|
|
|
|
/** @brief TWI master driver transfer types. */
|
|
typedef enum
|
|
{
|
|
NRFX_TWIM_XFER_TX, ///< TX transfer.
|
|
NRFX_TWIM_XFER_RX, ///< RX transfer.
|
|
NRFX_TWIM_XFER_TXRX, ///< TX transfer followed by RX transfer with repeated start.
|
|
NRFX_TWIM_XFER_TXTX ///< TX transfer followed by TX transfer with repeated start.
|
|
} nrfx_twim_xfer_type_t;
|
|
|
|
/** @brief Structure for a TWI transfer descriptor. */
|
|
typedef struct
|
|
{
|
|
nrfx_twim_xfer_type_t type; ///< Type of transfer.
|
|
uint8_t address; ///< Slave address.
|
|
size_t primary_length; ///< Number of bytes transferred.
|
|
size_t secondary_length; ///< Number of bytes transferred.
|
|
uint8_t * p_primary_buf; ///< Pointer to transferred data.
|
|
uint8_t * p_secondary_buf; ///< Pointer to transferred data.
|
|
} nrfx_twim_xfer_desc_t;
|
|
|
|
|
|
/** @brief Macro for setting the TX transfer descriptor. */
|
|
#define NRFX_TWIM_XFER_DESC_TX(addr, p_data, length) \
|
|
{ \
|
|
.type = NRFX_TWIM_XFER_TX, \
|
|
.address = addr, \
|
|
.primary_length = length, \
|
|
.secondary_length = 0, \
|
|
.p_primary_buf = p_data, \
|
|
.p_secondary_buf = NULL, \
|
|
}
|
|
|
|
/** @brief Macro for setting the RX transfer descriptor. */
|
|
#define NRFX_TWIM_XFER_DESC_RX(addr, p_data, length) \
|
|
{ \
|
|
.type = NRFX_TWIM_XFER_RX, \
|
|
.address = addr, \
|
|
.primary_length = length, \
|
|
.secondary_length = 0, \
|
|
.p_primary_buf = p_data, \
|
|
.p_secondary_buf = NULL, \
|
|
}
|
|
|
|
/** @brief Macro for setting the TX-RX transfer descriptor. */
|
|
#define NRFX_TWIM_XFER_DESC_TXRX(addr, p_tx, tx_len, p_rx, rx_len) \
|
|
{ \
|
|
.type = NRFX_TWIM_XFER_TXRX, \
|
|
.address = addr, \
|
|
.primary_length = tx_len, \
|
|
.secondary_length = rx_len, \
|
|
.p_primary_buf = p_tx, \
|
|
.p_secondary_buf = p_rx, \
|
|
}
|
|
|
|
/** @brief Macro for setting the TX-TX transfer descriptor. */
|
|
#define NRFX_TWIM_XFER_DESC_TXTX(addr, p_tx, tx_len, p_tx2, tx_len2) \
|
|
{ \
|
|
.type = NRFX_TWIM_XFER_TXTX, \
|
|
.address = addr, \
|
|
.primary_length = tx_len, \
|
|
.secondary_length = tx_len2, \
|
|
.p_primary_buf = p_tx, \
|
|
.p_secondary_buf = p_tx2, \
|
|
}
|
|
|
|
/** @brief Structure for a TWI event. */
|
|
typedef struct
|
|
{
|
|
nrfx_twim_evt_type_t type; ///< Event type.
|
|
nrfx_twim_xfer_desc_t xfer_desc; ///< Transfer details.
|
|
} nrfx_twim_evt_t;
|
|
|
|
/** @brief TWI event handler prototype. */
|
|
typedef void (* nrfx_twim_evt_handler_t)(nrfx_twim_evt_t const * p_event,
|
|
void * p_context);
|
|
|
|
/**
|
|
* @brief Function for initializing the TWI driver instance.
|
|
*
|
|
* @param[in] p_instance Pointer to the driver instance structure.
|
|
* @param[in] p_config Pointer to the structure with the initial configuration.
|
|
* @param[in] event_handler Event handler provided by the user. If NULL, blocking mode is enabled.
|
|
* @param[in] p_context Context passed to event handler.
|
|
*
|
|
* @retval NRFX_SUCCESS Initialization was successful.
|
|
* @retval NRFX_ERROR_INVALID_STATE The driver is in invalid state.
|
|
* @retval NRFX_ERROR_BUSY Some other peripheral with the same
|
|
* instance ID is already in use. This is
|
|
* possible only if @ref nrfx_prs module
|
|
* is enabled.
|
|
*/
|
|
nrfx_err_t nrfx_twim_init(nrfx_twim_t const * p_instance,
|
|
nrfx_twim_config_t const * p_config,
|
|
nrfx_twim_evt_handler_t event_handler,
|
|
void * p_context);
|
|
|
|
/**
|
|
* @brief Function for uninitializing the TWI instance.
|
|
*
|
|
* @param[in] p_instance Pointer to the driver instance structure.
|
|
*/
|
|
void nrfx_twim_uninit(nrfx_twim_t const * p_instance);
|
|
|
|
/**
|
|
* @brief Function for enabling the TWI instance.
|
|
*
|
|
* @param[in] p_instance Pointer to the driver instance structure.
|
|
*/
|
|
void nrfx_twim_enable(nrfx_twim_t const * p_instance);
|
|
|
|
/**
|
|
* @brief Function for disabling the TWI instance.
|
|
*
|
|
* @param[in] p_instance Pointer to the driver instance structure.
|
|
*/
|
|
void nrfx_twim_disable(nrfx_twim_t const * p_instance);
|
|
|
|
/**
|
|
* @brief Function for sending data to a TWI slave.
|
|
*
|
|
* The transmission will be stopped when an error occurs. If a transfer is ongoing,
|
|
* the function returns the error code @ref NRFX_ERROR_BUSY.
|
|
*
|
|
* @note Peripherals using EasyDMA (including TWIM) require the transfer buffers
|
|
* to be placed in the Data RAM region. If this condition is not met,
|
|
* this function fails with the error code NRFX_ERROR_INVALID_ADDR.
|
|
*
|
|
* @param[in] p_instance Pointer to the driver instance structure.
|
|
* @param[in] address Address of a specific slave device (only 7 LSB).
|
|
* @param[in] p_data Pointer to a transmit buffer.
|
|
* @param[in] length Number of bytes to send. Maximum possible length is
|
|
* dependent on the used SoC (see the MAXCNT register
|
|
* description in the Product Specification). The driver
|
|
* checks it with assertion.
|
|
* @param[in] no_stop If set, the stop condition is not generated on the bus
|
|
* after the transfer has completed successfully (allowing
|
|
* for a repeated start in the next transfer).
|
|
*
|
|
* @retval NRFX_SUCCESS The procedure is successful.
|
|
* @retval NRFX_ERROR_BUSY The driver is not ready for a new transfer.
|
|
* @retval NRFX_ERROR_INTERNAL Error is detected by hardware.
|
|
* @retval NRFX_ERROR_INVALID_ADDR The provided buffer is not placed in the Data RAM region.
|
|
* @retval NRFX_ERROR_DRV_TWI_ERR_ANACK NACK is received after sending the address in polling mode.
|
|
* @retval NRFX_ERROR_DRV_TWI_ERR_DNACK NACK is received after sending a data byte in polling mode.
|
|
*/
|
|
nrfx_err_t nrfx_twim_tx(nrfx_twim_t const * p_instance,
|
|
uint8_t address,
|
|
uint8_t const * p_data,
|
|
size_t length,
|
|
bool no_stop);
|
|
|
|
/**
|
|
* @brief Function for reading data from a TWI slave.
|
|
*
|
|
* The transmission will be stopped when an error occurs. If a transfer is ongoing,
|
|
* the function returns the error code @ref NRFX_ERROR_BUSY.
|
|
*
|
|
* @param[in] p_instance Pointer to the driver instance structure.
|
|
* @param[in] address Address of a specific slave device (only 7 LSB).
|
|
* @param[in] p_data Pointer to a receive buffer.
|
|
* @param[in] length Number of bytes to be received. Maximum possible length
|
|
* is dependent on the used SoC (see the MAXCNT register
|
|
* description in the Product Specification). The driver
|
|
* checks it with assertion.
|
|
*
|
|
* @retval NRFX_SUCCESS The procedure is successful.
|
|
* @retval NRFX_ERROR_BUSY The driver is not ready for a new transfer.
|
|
* @retval NRFX_ERROR_INTERNAL Error is detected by hardware.
|
|
* @retval NRFX_ERROR_DRV_TWI_ERR_ANACK NACK is received after sending the address in polling mode.
|
|
* @retval NRFX_ERROR_DRV_TWI_ERR_DNACK NACK is received after sending a data byte in polling mode.
|
|
*/
|
|
nrfx_err_t nrfx_twim_rx(nrfx_twim_t const * p_instance,
|
|
uint8_t address,
|
|
uint8_t * p_data,
|
|
size_t length);
|
|
|
|
/**
|
|
* @brief Function for preparing a TWI transfer.
|
|
*
|
|
* The following transfer types can be configured (@ref nrfx_twim_xfer_desc_t::type):
|
|
* - @ref NRFX_TWIM_XFER_TXRX - Write operation followed by a read operation (without STOP condition in between).
|
|
* - @ref NRFX_TWIM_XFER_TXTX - Write operation followed by a write operation (without STOP condition in between).
|
|
* - @ref NRFX_TWIM_XFER_TX - Write operation (with or without STOP condition).
|
|
* - @ref NRFX_TWIM_XFER_RX - Read operation (with STOP condition).
|
|
*
|
|
* @note TX-RX and TX-TX transfers are supported only in non-blocking mode.
|
|
*
|
|
* Additional options are provided using the flags parameter:
|
|
* - @ref NRFX_TWIM_FLAG_TX_POSTINC and @ref NRFX_TWIM_FLAG_RX_POSTINC - Post-incrementation of buffer addresses.
|
|
* - @ref NRFX_TWIM_FLAG_NO_XFER_EVT_HANDLER - No user event handler after the transfer completion. In most cases, this also means no interrupt at the end of the transfer.
|
|
* - @ref NRFX_TWIM_FLAG_HOLD_XFER - Driver is not starting the transfer. Use this flag if the transfer is triggered externally by PPI.
|
|
* Use @ref nrfx_twim_start_task_get to get the address of the start task.
|
|
* - @ref NRFX_TWIM_FLAG_REPEATED_XFER - Prepare for repeated transfers. You can set up a number of transfers that will be triggered externally (for example by PPI).
|
|
* An example is a TXRX transfer with the options @ref NRFX_TWIM_FLAG_RX_POSTINC, @ref NRFX_TWIM_FLAG_NO_XFER_EVT_HANDLER, and @ref NRFX_TWIM_FLAG_REPEATED_XFER.
|
|
* After the transfer is set up, a set of transfers can be triggered by PPI that will read, for example, the same register of an
|
|
* external component and put it into a RAM buffer without any interrupts. @ref nrfx_twim_stopped_event_get can be used to get the
|
|
* address of the STOPPED event, which can be used to count the number of transfers. If @ref NRFX_TWIM_FLAG_REPEATED_XFER is used,
|
|
* the driver does not set the driver instance into busy state, so you must ensure that the next transfers are set up
|
|
* when TWIM is not active.
|
|
* - @ref NRFX_TWIM_FLAG_TX_NO_STOP - No stop condition after the TX transfer.
|
|
*
|
|
* @note
|
|
* Some flag combinations are invalid:
|
|
* - @ref NRFX_TWIM_FLAG_TX_NO_STOP with @ref nrfx_twim_xfer_desc_t::type different than @ref NRFX_TWIM_XFER_TX
|
|
* - @ref NRFX_TWIM_FLAG_REPEATED_XFER with @ref nrfx_twim_xfer_desc_t::type set to @ref NRFX_TWIM_XFER_TXTX
|
|
*
|
|
* If @ref nrfx_twim_xfer_desc_t::type is set to @ref NRFX_TWIM_XFER_TX and the @ref NRFX_TWIM_FLAG_TX_NO_STOP and @ref NRFX_TWIM_FLAG_REPEATED_XFER
|
|
* flags are set, two tasks must be used to trigger a transfer: TASKS_RESUME followed by TASKS_STARTTX. If no stop condition is generated,
|
|
* TWIM is in SUSPENDED state. Therefore, it must be resumed before the transfer can be started.
|
|
*
|
|
* @note Peripherals using EasyDMA (including TWIM) require the transfer buffers
|
|
* to be placed in the Data RAM region. If this condition is not met,
|
|
* this function will fail with the error code NRFX_ERROR_INVALID_ADDR.
|
|
*
|
|
* @param[in] p_instance Pointer to the driver instance structure.
|
|
* @param[in] p_xfer_desc Pointer to the transfer descriptor.
|
|
* @param[in] flags Transfer options (0 for default settings).
|
|
*
|
|
* @retval NRFX_SUCCESS The procedure is successful.
|
|
* @retval NRFX_ERROR_BUSY The driver is not ready for a new transfer.
|
|
* @retval NRFX_ERROR_NOT_SUPPORTED The provided parameters are not supported.
|
|
* @retval NRFX_ERROR_INTERNAL Error is detected by hardware.
|
|
* @retval NRFX_ERROR_INVALID_ADDR The provided buffers are not placed in the Data RAM region.
|
|
* @retval NRFX_ERROR_DRV_TWI_ERR_ANACK NACK is received after sending the address.
|
|
* @retval NRFX_ERROR_DRV_TWI_ERR_DNACK NACK is received after sending a data byte.
|
|
*/
|
|
nrfx_err_t nrfx_twim_xfer(nrfx_twim_t const * p_instance,
|
|
nrfx_twim_xfer_desc_t const * p_xfer_desc,
|
|
uint32_t flags);
|
|
|
|
/**
|
|
* @brief Function for checking the TWI driver state.
|
|
*
|
|
* @param[in] p_instance TWI instance.
|
|
*
|
|
* @retval true The TWI driver is currently busy performing a transfer.
|
|
* @retval false The TWI driver is ready for a new transfer.
|
|
*/
|
|
bool nrfx_twim_is_busy(nrfx_twim_t const * p_instance);
|
|
|
|
|
|
/**
|
|
* @brief Function for returning the address of a TWIM start task.
|
|
*
|
|
* This function is to be used if @ref nrfx_twim_xfer was called with the flag @ref NRFX_TWIM_FLAG_HOLD_XFER.
|
|
* In that case, the transfer is not started by the driver, but it must be started externally by PPI.
|
|
*
|
|
* @param[in] p_instance Pointer to the driver instance structure.
|
|
* @param[in] xfer_type Transfer type used in the last call of the @ref nrfx_twim_xfer function.
|
|
*
|
|
* @return Start task address (TX or RX) depending on the value of xfer_type.
|
|
*/
|
|
uint32_t nrfx_twim_start_task_get(nrfx_twim_t const * p_instance, nrfx_twim_xfer_type_t xfer_type);
|
|
|
|
/**
|
|
* @brief Function for returning the address of a STOPPED TWIM event.
|
|
*
|
|
* A STOPPED event can be used to detect the end of a transfer if the @ref NRFX_TWIM_FLAG_NO_XFER_EVT_HANDLER
|
|
* option is used.
|
|
*
|
|
* @param[in] p_instance Pointer to the driver instance structure.
|
|
*
|
|
* @return STOPPED event address.
|
|
*/
|
|
uint32_t nrfx_twim_stopped_event_get(nrfx_twim_t const * p_instance);
|
|
|
|
/** @} */
|
|
|
|
void nrfx_twim_0_irq_handler(void);
|
|
void nrfx_twim_1_irq_handler(void);
|
|
void nrfx_twim_2_irq_handler(void);
|
|
void nrfx_twim_3_irq_handler(void);
|
|
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif // NRFX_TWIM_H__
|
|
|