summaryrefslogtreecommitdiff
path: root/nrfdemo/build/tfm/api_ns/platform/ext/driver
diff options
context:
space:
mode:
authorMichal Hanus <mikehanus@protonmail.com>2025-04-19 22:50:44 +0200
committerMichal Hanus <mikehanus@protonmail.com>2025-04-19 22:50:44 +0200
commit9078b7ec09b135f091cb951ed234bf013c9c838e (patch)
treeba953e144c2dd42d327a83720cdfc9fb5bb9fe34 /nrfdemo/build/tfm/api_ns/platform/ext/driver
parent2e13c372f1419f08dab7797b244681f889dd9bcf (diff)
bme680 added
Diffstat (limited to 'nrfdemo/build/tfm/api_ns/platform/ext/driver')
-rw-r--r--nrfdemo/build/tfm/api_ns/platform/ext/driver/Driver_Common.h69
-rw-r--r--nrfdemo/build/tfm/api_ns/platform/ext/driver/Driver_Flash.h204
-rw-r--r--nrfdemo/build/tfm/api_ns/platform/ext/driver/Driver_USART.h341
3 files changed, 0 insertions, 614 deletions
diff --git a/nrfdemo/build/tfm/api_ns/platform/ext/driver/Driver_Common.h b/nrfdemo/build/tfm/api_ns/platform/ext/driver/Driver_Common.h
deleted file mode 100644
index cdf44b3..0000000
--- a/nrfdemo/build/tfm/api_ns/platform/ext/driver/Driver_Common.h
+++ /dev/null
@@ -1,69 +0,0 @@
-/*
- * Copyright (c) 2013-2016 ARM Limited. All rights reserved.
- *
- * SPDX-License-Identifier: Apache-2.0
- *
- * Licensed under the Apache License, Version 2.0 (the License); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an AS IS BASIS, WITHOUT
- * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- * $Date: 2. Jan 2014
- * $Revision: V2.00
- *
- * Project: Common Driver definitions
- */
-
-/* History:
- * Version 2.00
- * Changed prefix ARM_DRV -> ARM_DRIVER
- * Added General return codes definitions
- * Version 1.10
- * Namespace prefix ARM_ added
- * Version 1.00
- * Initial release
- */
-
-#ifndef __DRIVER_COMMON_H
-#define __DRIVER_COMMON_H
-
-#include <stddef.h>
-#include <stdint.h>
-#include <stdbool.h>
-
-#define ARM_DRIVER_VERSION_MAJOR_MINOR(major,minor) (((major) << 8) | (minor))
-
-/**
-\brief Driver Version
-*/
-typedef struct _ARM_DRIVER_VERSION {
- uint16_t api; ///< API version
- uint16_t drv; ///< Driver version
-} ARM_DRIVER_VERSION;
-
-/* General return codes */
-#define ARM_DRIVER_OK 0 ///< Operation succeeded
-#define ARM_DRIVER_ERROR -1 ///< Unspecified error
-#define ARM_DRIVER_ERROR_BUSY -2 ///< Driver is busy
-#define ARM_DRIVER_ERROR_TIMEOUT -3 ///< Timeout occurred
-#define ARM_DRIVER_ERROR_UNSUPPORTED -4 ///< Operation not supported
-#define ARM_DRIVER_ERROR_PARAMETER -5 ///< Parameter error
-#define ARM_DRIVER_ERROR_SPECIFIC -6 ///< Start of driver specific errors
-
-/**
-\brief General power states
-*/
-typedef enum _ARM_POWER_STATE {
- ARM_POWER_OFF, ///< Power off: no operation possible
- ARM_POWER_LOW, ///< Low Power mode: retain state, detect and signal wake-up events
- ARM_POWER_FULL ///< Power on: full operation at maximum performance
-} ARM_POWER_STATE;
-
-#endif /* __DRIVER_COMMON_H */
diff --git a/nrfdemo/build/tfm/api_ns/platform/ext/driver/Driver_Flash.h b/nrfdemo/build/tfm/api_ns/platform/ext/driver/Driver_Flash.h
deleted file mode 100644
index 287add1..0000000
--- a/nrfdemo/build/tfm/api_ns/platform/ext/driver/Driver_Flash.h
+++ /dev/null
@@ -1,204 +0,0 @@
-/*
- * Copyright (c) 2013-2017 ARM Limited. All rights reserved.
- *
- * SPDX-License-Identifier: Apache-2.0
- *
- * Licensed under the Apache License, Version 2.0 (the License); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an AS IS BASIS, WITHOUT
- * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- * $Date: 2. Feb 2017
- * $Revision: V2.1
- *
- * Project: Flash Driver definitions
- */
-
-/* History:
- * Version 2.1
- * ARM_FLASH_STATUS made volatile
- * Version 2.0
- * Renamed driver NOR -> Flash (more generic)
- * Non-blocking operation
- * Added Events, Status and Capabilities
- * Linked Flash information (GetInfo)
- * Version 1.11
- * Changed prefix ARM_DRV -> ARM_DRIVER
- * Version 1.10
- * Namespace prefix ARM_ added
- * Version 1.00
- * Initial release
- */
-
-#ifndef DRIVER_FLASH_H_
-#define DRIVER_FLASH_H_
-
-#ifdef __cplusplus
-extern "C"
-{
-#endif
-
-#include "Driver_Common.h"
-
-#define ARM_FLASH_API_VERSION ARM_DRIVER_VERSION_MAJOR_MINOR(2,1) /* API version */
-
-
-#define _ARM_Driver_Flash_(n) Driver_Flash##n
-#define ARM_Driver_Flash_(n) _ARM_Driver_Flash_(n)
-
-
-#define ARM_FLASH_SECTOR_INFO(addr,size) { (addr), (addr)+(size)-1 }
-
-/**
-\brief Flash Sector information
-*/
-typedef struct _ARM_FLASH_SECTOR {
- uint32_t start; ///< Sector Start address
- uint32_t end; ///< Sector End address (start+size-1)
-} const ARM_FLASH_SECTOR;
-
-/**
-\brief Flash information
-*/
-typedef struct _ARM_FLASH_INFO {
- ARM_FLASH_SECTOR *sector_info; ///< Sector layout information (NULL=Uniform sectors)
- uint32_t sector_count; ///< Number of sectors
- uint32_t sector_size; ///< Uniform sector size in bytes (0=sector_info used)
- uint32_t page_size; ///< Optimal programming page size in bytes
- uint32_t program_unit; ///< Smallest programmable unit in bytes
- uint8_t erased_value; ///< Contents of erased memory (usually 0xFF)
-} const ARM_FLASH_INFO;
-
-
-/**
-\brief Flash Status
-*/
-typedef volatile struct _ARM_FLASH_STATUS {
- uint32_t busy : 1; ///< Flash busy flag
- uint32_t error : 1; ///< Read/Program/Erase error flag (cleared on start of next operation)
- uint32_t reserved : 30;
-} ARM_FLASH_STATUS;
-
-
-/****** Flash Event *****/
-#define ARM_FLASH_EVENT_READY (1UL << 0) ///< Flash Ready
-#define ARM_FLASH_EVENT_ERROR (1UL << 1) ///< Read/Program/Erase Error
-
-
-// Function documentation
-/**
- \fn ARM_DRIVER_VERSION ARM_Flash_GetVersion (void)
- \brief Get driver version.
- \return \ref ARM_DRIVER_VERSION
-*/
-/**
- \fn ARM_FLASH_CAPABILITIES ARM_Flash_GetCapabilities (void)
- \brief Get driver capabilities.
- \return \ref ARM_FLASH_CAPABILITIES
-*/
-/**
- \fn int32_t ARM_Flash_Initialize (ARM_Flash_SignalEvent_t cb_event)
- \brief Initialize the Flash Interface.
- \param[in] cb_event Pointer to \ref ARM_Flash_SignalEvent
- \return \ref execution_status
-*/
-/**
- \fn int32_t ARM_Flash_Uninitialize (void)
- \brief De-initialize the Flash Interface.
- \return \ref execution_status
-*/
-/**
- \fn int32_t ARM_Flash_PowerControl (ARM_POWER_STATE state)
- \brief Control the Flash interface power.
- \param[in] state Power state
- \return \ref execution_status
-*/
-/**
- \fn int32_t ARM_Flash_ReadData (uint32_t addr, void *data, uint32_t cnt)
- \brief Read data from Flash.
- \param[in] addr Data address.
- \param[out] data Pointer to a buffer storing the data read from Flash.
- \param[in] cnt Number of data items to read.
- \return number of data items read or \ref execution_status
-*/
-/**
- \fn int32_t ARM_Flash_ProgramData (uint32_t addr, const void *data, uint32_t cnt)
- \brief Program data to Flash.
- \param[in] addr Data address.
- \param[in] data Pointer to a buffer containing the data to be programmed to Flash.
- \param[in] cnt Number of data items to program.
- \return number of data items programmed or \ref execution_status
-*/
-/**
- \fn int32_t ARM_Flash_EraseSector (uint32_t addr)
- \brief Erase Flash Sector.
- \param[in] addr Sector address
- \return \ref execution_status
-*/
-/**
- \fn int32_t ARM_Flash_EraseChip (void)
- \brief Erase complete Flash.
- Optional function for faster full chip erase.
- \return \ref execution_status
-*/
-/**
- \fn ARM_FLASH_STATUS ARM_Flash_GetStatus (void)
- \brief Get Flash status.
- \return Flash status \ref ARM_FLASH_STATUS
-*/
-/**
- \fn ARM_FLASH_INFO * ARM_Flash_GetInfo (void)
- \brief Get Flash information.
- \return Pointer to Flash information \ref ARM_FLASH_INFO
-*/
-
-/**
- \fn void ARM_Flash_SignalEvent (uint32_t event)
- \brief Signal Flash event.
- \param[in] event Event notification mask
- \return none
-*/
-
-typedef void (*ARM_Flash_SignalEvent_t) (uint32_t event); ///< Pointer to \ref ARM_Flash_SignalEvent : Signal Flash Event.
-
-
-/**
-\brief Flash Driver Capabilities.
-*/
-typedef struct _ARM_FLASH_CAPABILITIES {
- uint32_t event_ready : 1; ///< Signal Flash Ready event
- uint32_t data_width : 2; ///< Data width: 0=8-bit, 1=16-bit, 2=32-bit
- uint32_t erase_chip : 1; ///< Supports EraseChip operation
- uint32_t reserved : 28; ///< Reserved (must be zero)
-} ARM_FLASH_CAPABILITIES;
-
-
-/**
-\brief Access structure of the Flash Driver
-*/
-typedef struct _ARM_DRIVER_FLASH {
- ARM_DRIVER_VERSION (*GetVersion) (void); ///< Pointer to \ref ARM_Flash_GetVersion : Get driver version.
- ARM_FLASH_CAPABILITIES (*GetCapabilities)(void); ///< Pointer to \ref ARM_Flash_GetCapabilities : Get driver capabilities.
- int32_t (*Initialize) (ARM_Flash_SignalEvent_t cb_event); ///< Pointer to \ref ARM_Flash_Initialize : Initialize Flash Interface.
- int32_t (*Uninitialize) (void); ///< Pointer to \ref ARM_Flash_Uninitialize : De-initialize Flash Interface.
- int32_t (*PowerControl) (ARM_POWER_STATE state); ///< Pointer to \ref ARM_Flash_PowerControl : Control Flash Interface Power.
- int32_t (*ReadData) (uint32_t addr, void *data, uint32_t cnt); ///< Pointer to \ref ARM_Flash_ReadData : Read data from Flash.
- int32_t (*ProgramData) (uint32_t addr, const void *data, uint32_t cnt); ///< Pointer to \ref ARM_Flash_ProgramData : Program data to Flash.
- int32_t (*EraseSector) (uint32_t addr); ///< Pointer to \ref ARM_Flash_EraseSector : Erase Flash Sector.
- int32_t (*EraseChip) (void); ///< Pointer to \ref ARM_Flash_EraseChip : Erase complete Flash.
- ARM_FLASH_STATUS (*GetStatus) (void); ///< Pointer to \ref ARM_Flash_GetStatus : Get Flash status.
- ARM_FLASH_INFO * (*GetInfo) (void); ///< Pointer to \ref ARM_Flash_GetInfo : Get Flash information.
-} const ARM_DRIVER_FLASH;
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif /* DRIVER_FLASH_H_ */
diff --git a/nrfdemo/build/tfm/api_ns/platform/ext/driver/Driver_USART.h b/nrfdemo/build/tfm/api_ns/platform/ext/driver/Driver_USART.h
deleted file mode 100644
index 237496b..0000000
--- a/nrfdemo/build/tfm/api_ns/platform/ext/driver/Driver_USART.h
+++ /dev/null
@@ -1,341 +0,0 @@
-/*
- * Copyright (c) 2013-2017 ARM Limited. All rights reserved.
- *
- * SPDX-License-Identifier: Apache-2.0
- *
- * Licensed under the Apache License, Version 2.0 (the License); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an AS IS BASIS, WITHOUT
- * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- * $Date: 2. Feb 2017
- * $Revision: V2.3
- *
- * Project: USART (Universal Synchronous Asynchronous Receiver Transmitter)
- * Driver definitions
- */
-
-/* History:
- * Version 2.3
- * ARM_USART_STATUS and ARM_USART_MODEM_STATUS made volatile
- * Version 2.2
- * Corrected ARM_USART_CPOL_Pos and ARM_USART_CPHA_Pos definitions
- * Version 2.1
- * Removed optional argument parameter from Signal Event
- * Version 2.0
- * New simplified driver:
- * complexity moved to upper layer (especially data handling)
- * more unified API for different communication interfaces
- * renamed driver UART -> USART (Asynchronous & Synchronous)
- * Added modes:
- * Synchronous
- * Single-wire
- * IrDA
- * Smart Card
- * Changed prefix ARM_DRV -> ARM_DRIVER
- * Version 1.10
- * Namespace prefix ARM_ added
- * Version 1.01
- * Added events:
- * ARM_UART_EVENT_TX_EMPTY, ARM_UART_EVENT_RX_TIMEOUT
- * ARM_UART_EVENT_TX_THRESHOLD, ARM_UART_EVENT_RX_THRESHOLD
- * Added functions: SetTxThreshold, SetRxThreshold
- * Added "rx_timeout_event" to capabilities
- * Version 1.00
- * Initial release
- */
-
-#ifndef DRIVER_USART_H_
-#define DRIVER_USART_H_
-
-#ifdef __cplusplus
-extern "C"
-{
-#endif
-
-#include "Driver_Common.h"
-
-#define ARM_USART_API_VERSION ARM_DRIVER_VERSION_MAJOR_MINOR(2,3) /* API version */
-
-
-/****** USART Control Codes *****/
-
-#define ARM_USART_CONTROL_Pos 0
-#define ARM_USART_CONTROL_Msk (0xFFUL << ARM_USART_CONTROL_Pos)
-
-/*----- USART Control Codes: Mode -----*/
-#define ARM_USART_MODE_ASYNCHRONOUS (0x01UL << ARM_USART_CONTROL_Pos) ///< UART (Asynchronous); arg = Baudrate
-#define ARM_USART_MODE_SYNCHRONOUS_MASTER (0x02UL << ARM_USART_CONTROL_Pos) ///< Synchronous Master (generates clock signal); arg = Baudrate
-#define ARM_USART_MODE_SYNCHRONOUS_SLAVE (0x03UL << ARM_USART_CONTROL_Pos) ///< Synchronous Slave (external clock signal)
-#define ARM_USART_MODE_SINGLE_WIRE (0x04UL << ARM_USART_CONTROL_Pos) ///< UART Single-wire (half-duplex); arg = Baudrate
-#define ARM_USART_MODE_IRDA (0x05UL << ARM_USART_CONTROL_Pos) ///< UART IrDA; arg = Baudrate
-#define ARM_USART_MODE_SMART_CARD (0x06UL << ARM_USART_CONTROL_Pos) ///< UART Smart Card; arg = Baudrate
-
-/*----- USART Control Codes: Mode Parameters: Data Bits -----*/
-#define ARM_USART_DATA_BITS_Pos 8
-#define ARM_USART_DATA_BITS_Msk (7UL << ARM_USART_DATA_BITS_Pos)
-#define ARM_USART_DATA_BITS_5 (5UL << ARM_USART_DATA_BITS_Pos) ///< 5 Data bits
-#define ARM_USART_DATA_BITS_6 (6UL << ARM_USART_DATA_BITS_Pos) ///< 6 Data bit
-#define ARM_USART_DATA_BITS_7 (7UL << ARM_USART_DATA_BITS_Pos) ///< 7 Data bits
-#define ARM_USART_DATA_BITS_8 (0UL << ARM_USART_DATA_BITS_Pos) ///< 8 Data bits (default)
-#define ARM_USART_DATA_BITS_9 (1UL << ARM_USART_DATA_BITS_Pos) ///< 9 Data bits
-
-/*----- USART Control Codes: Mode Parameters: Parity -----*/
-#define ARM_USART_PARITY_Pos 12
-#define ARM_USART_PARITY_Msk (3UL << ARM_USART_PARITY_Pos)
-#define ARM_USART_PARITY_NONE (0UL << ARM_USART_PARITY_Pos) ///< No Parity (default)
-#define ARM_USART_PARITY_EVEN (1UL << ARM_USART_PARITY_Pos) ///< Even Parity
-#define ARM_USART_PARITY_ODD (2UL << ARM_USART_PARITY_Pos) ///< Odd Parity
-
-/*----- USART Control Codes: Mode Parameters: Stop Bits -----*/
-#define ARM_USART_STOP_BITS_Pos 14
-#define ARM_USART_STOP_BITS_Msk (3UL << ARM_USART_STOP_BITS_Pos)
-#define ARM_USART_STOP_BITS_1 (0UL << ARM_USART_STOP_BITS_Pos) ///< 1 Stop bit (default)
-#define ARM_USART_STOP_BITS_2 (1UL << ARM_USART_STOP_BITS_Pos) ///< 2 Stop bits
-#define ARM_USART_STOP_BITS_1_5 (2UL << ARM_USART_STOP_BITS_Pos) ///< 1.5 Stop bits
-#define ARM_USART_STOP_BITS_0_5 (3UL << ARM_USART_STOP_BITS_Pos) ///< 0.5 Stop bits
-
-/*----- USART Control Codes: Mode Parameters: Flow Control -----*/
-#define ARM_USART_FLOW_CONTROL_Pos 16
-#define ARM_USART_FLOW_CONTROL_Msk (3UL << ARM_USART_FLOW_CONTROL_Pos)
-#define ARM_USART_FLOW_CONTROL_NONE (0UL << ARM_USART_FLOW_CONTROL_Pos) ///< No Flow Control (default)
-#define ARM_USART_FLOW_CONTROL_RTS (1UL << ARM_USART_FLOW_CONTROL_Pos) ///< RTS Flow Control
-#define ARM_USART_FLOW_CONTROL_CTS (2UL << ARM_USART_FLOW_CONTROL_Pos) ///< CTS Flow Control
-#define ARM_USART_FLOW_CONTROL_RTS_CTS (3UL << ARM_USART_FLOW_CONTROL_Pos) ///< RTS/CTS Flow Control
-
-/*----- USART Control Codes: Mode Parameters: Clock Polarity (Synchronous mode) -----*/
-#define ARM_USART_CPOL_Pos 18
-#define ARM_USART_CPOL_Msk (1UL << ARM_USART_CPOL_Pos)
-#define ARM_USART_CPOL0 (0UL << ARM_USART_CPOL_Pos) ///< CPOL = 0 (default)
-#define ARM_USART_CPOL1 (1UL << ARM_USART_CPOL_Pos) ///< CPOL = 1
-
-/*----- USART Control Codes: Mode Parameters: Clock Phase (Synchronous mode) -----*/
-#define ARM_USART_CPHA_Pos 19
-#define ARM_USART_CPHA_Msk (1UL << ARM_USART_CPHA_Pos)
-#define ARM_USART_CPHA0 (0UL << ARM_USART_CPHA_Pos) ///< CPHA = 0 (default)
-#define ARM_USART_CPHA1 (1UL << ARM_USART_CPHA_Pos) ///< CPHA = 1
-
-
-/*----- USART Control Codes: Miscellaneous Controls -----*/
-#define ARM_USART_SET_DEFAULT_TX_VALUE (0x10UL << ARM_USART_CONTROL_Pos) ///< Set default Transmit value (Synchronous Receive only); arg = value
-#define ARM_USART_SET_IRDA_PULSE (0x11UL << ARM_USART_CONTROL_Pos) ///< Set IrDA Pulse in ns; arg: 0=3/16 of bit period
-#define ARM_USART_SET_SMART_CARD_GUARD_TIME (0x12UL << ARM_USART_CONTROL_Pos) ///< Set Smart Card Guard Time; arg = number of bit periods
-#define ARM_USART_SET_SMART_CARD_CLOCK (0x13UL << ARM_USART_CONTROL_Pos) ///< Set Smart Card Clock in Hz; arg: 0=Clock not generated
-#define ARM_USART_CONTROL_SMART_CARD_NACK (0x14UL << ARM_USART_CONTROL_Pos) ///< Smart Card NACK generation; arg: 0=disabled, 1=enabled
-#define ARM_USART_CONTROL_TX (0x15UL << ARM_USART_CONTROL_Pos) ///< Transmitter; arg: 0=disabled, 1=enabled
-#define ARM_USART_CONTROL_RX (0x16UL << ARM_USART_CONTROL_Pos) ///< Receiver; arg: 0=disabled, 1=enabled
-#define ARM_USART_CONTROL_BREAK (0x17UL << ARM_USART_CONTROL_Pos) ///< Continuous Break transmission; arg: 0=disabled, 1=enabled
-#define ARM_USART_ABORT_SEND (0x18UL << ARM_USART_CONTROL_Pos) ///< Abort \ref ARM_USART_Send
-#define ARM_USART_ABORT_RECEIVE (0x19UL << ARM_USART_CONTROL_Pos) ///< Abort \ref ARM_USART_Receive
-#define ARM_USART_ABORT_TRANSFER (0x1AUL << ARM_USART_CONTROL_Pos) ///< Abort \ref ARM_USART_Transfer
-
-
-
-/****** USART specific error codes *****/
-#define ARM_USART_ERROR_MODE (ARM_DRIVER_ERROR_SPECIFIC - 1) ///< Specified Mode not supported
-#define ARM_USART_ERROR_BAUDRATE (ARM_DRIVER_ERROR_SPECIFIC - 2) ///< Specified baudrate not supported
-#define ARM_USART_ERROR_DATA_BITS (ARM_DRIVER_ERROR_SPECIFIC - 3) ///< Specified number of Data bits not supported
-#define ARM_USART_ERROR_PARITY (ARM_DRIVER_ERROR_SPECIFIC - 4) ///< Specified Parity not supported
-#define ARM_USART_ERROR_STOP_BITS (ARM_DRIVER_ERROR_SPECIFIC - 5) ///< Specified number of Stop bits not supported
-#define ARM_USART_ERROR_FLOW_CONTROL (ARM_DRIVER_ERROR_SPECIFIC - 6) ///< Specified Flow Control not supported
-#define ARM_USART_ERROR_CPOL (ARM_DRIVER_ERROR_SPECIFIC - 7) ///< Specified Clock Polarity not supported
-#define ARM_USART_ERROR_CPHA (ARM_DRIVER_ERROR_SPECIFIC - 8) ///< Specified Clock Phase not supported
-
-
-/**
-\brief USART Status
-*/
-typedef volatile struct _ARM_USART_STATUS {
- uint32_t tx_busy : 1; ///< Transmitter busy flag
- uint32_t rx_busy : 1; ///< Receiver busy flag
- uint32_t tx_underflow : 1; ///< Transmit data underflow detected (cleared on start of next send operation)
- uint32_t rx_overflow : 1; ///< Receive data overflow detected (cleared on start of next receive operation)
- uint32_t rx_break : 1; ///< Break detected on receive (cleared on start of next receive operation)
- uint32_t rx_framing_error : 1; ///< Framing error detected on receive (cleared on start of next receive operation)
- uint32_t rx_parity_error : 1; ///< Parity error detected on receive (cleared on start of next receive operation)
- uint32_t reserved : 25;
-} ARM_USART_STATUS;
-
-/**
-\brief USART Modem Control
-*/
-typedef enum _ARM_USART_MODEM_CONTROL {
- ARM_USART_RTS_CLEAR, ///< Deactivate RTS
- ARM_USART_RTS_SET, ///< Activate RTS
- ARM_USART_DTR_CLEAR, ///< Deactivate DTR
- ARM_USART_DTR_SET ///< Activate DTR
-} ARM_USART_MODEM_CONTROL;
-
-/**
-\brief USART Modem Status
-*/
-typedef volatile struct _ARM_USART_MODEM_STATUS {
- uint32_t cts : 1; ///< CTS state: 1=Active, 0=Inactive
- uint32_t dsr : 1; ///< DSR state: 1=Active, 0=Inactive
- uint32_t dcd : 1; ///< DCD state: 1=Active, 0=Inactive
- uint32_t ri : 1; ///< RI state: 1=Active, 0=Inactive
- uint32_t reserved : 28;
-} ARM_USART_MODEM_STATUS;
-
-
-/****** USART Event *****/
-#define ARM_USART_EVENT_SEND_COMPLETE (1UL << 0) ///< Send completed; however USART may still transmit data
-#define ARM_USART_EVENT_RECEIVE_COMPLETE (1UL << 1) ///< Receive completed
-#define ARM_USART_EVENT_TRANSFER_COMPLETE (1UL << 2) ///< Transfer completed
-#define ARM_USART_EVENT_TX_COMPLETE (1UL << 3) ///< Transmit completed (optional)
-#define ARM_USART_EVENT_TX_UNDERFLOW (1UL << 4) ///< Transmit data not available (Synchronous Slave)
-#define ARM_USART_EVENT_RX_OVERFLOW (1UL << 5) ///< Receive data overflow
-#define ARM_USART_EVENT_RX_TIMEOUT (1UL << 6) ///< Receive character timeout (optional)
-#define ARM_USART_EVENT_RX_BREAK (1UL << 7) ///< Break detected on receive
-#define ARM_USART_EVENT_RX_FRAMING_ERROR (1UL << 8) ///< Framing error detected on receive
-#define ARM_USART_EVENT_RX_PARITY_ERROR (1UL << 9) ///< Parity error detected on receive
-#define ARM_USART_EVENT_CTS (1UL << 10) ///< CTS state changed (optional)
-#define ARM_USART_EVENT_DSR (1UL << 11) ///< DSR state changed (optional)
-#define ARM_USART_EVENT_DCD (1UL << 12) ///< DCD state changed (optional)
-#define ARM_USART_EVENT_RI (1UL << 13) ///< RI state changed (optional)
-
-
-// Function documentation
-/**
- \fn ARM_DRIVER_VERSION ARM_USART_GetVersion (void)
- \brief Get driver version.
- \return \ref ARM_DRIVER_VERSION
-
- \fn ARM_USART_CAPABILITIES ARM_USART_GetCapabilities (void)
- \brief Get driver capabilities
- \return \ref ARM_USART_CAPABILITIES
-
- \fn int32_t ARM_USART_Initialize (ARM_USART_SignalEvent_t cb_event)
- \brief Initialize USART Interface.
- \param[in] cb_event Pointer to \ref ARM_USART_SignalEvent
- \return \ref execution_status
-
- \fn int32_t ARM_USART_Uninitialize (void)
- \brief De-initialize USART Interface.
- \return \ref execution_status
-
- \fn int32_t ARM_USART_PowerControl (ARM_POWER_STATE state)
- \brief Control USART Interface Power.
- \param[in] state Power state
- \return \ref execution_status
-
- \fn int32_t ARM_USART_Send (const void *data, uint32_t num)
- \brief Start sending data to USART transmitter.
- \param[in] data Pointer to buffer with data to send to USART transmitter
- \param[in] num Number of data items to send
- \return \ref execution_status
-
- \fn int32_t ARM_USART_Receive (void *data, uint32_t num)
- \brief Start receiving data from USART receiver.
- \param[out] data Pointer to buffer for data to receive from USART receiver
- \param[in] num Number of data items to receive
- \return \ref execution_status
-
- \fn int32_t ARM_USART_Transfer (const void *data_out,
- void *data_in,
- uint32_t num)
- \brief Start sending/receiving data to/from USART transmitter/receiver.
- \param[in] data_out Pointer to buffer with data to send to USART transmitter
- \param[out] data_in Pointer to buffer for data to receive from USART receiver
- \param[in] num Number of data items to transfer
- \return \ref execution_status
-
- \fn uint32_t ARM_USART_GetTxCount (void)
- \brief Get transmitted data count.
- \return number of data items transmitted
-
- \fn uint32_t ARM_USART_GetRxCount (void)
- \brief Get received data count.
- \return number of data items received
-
- \fn int32_t ARM_USART_Control (uint32_t control, uint32_t arg)
- \brief Control USART Interface.
- \param[in] control Operation
- \param[in] arg Argument of operation (optional)
- \return common \ref execution_status and driver specific \ref usart_execution_status
-
- \fn ARM_USART_STATUS ARM_USART_GetStatus (void)
- \brief Get USART status.
- \return USART status \ref ARM_USART_STATUS
-
- \fn int32_t ARM_USART_SetModemControl (ARM_USART_MODEM_CONTROL control)
- \brief Set USART Modem Control line state.
- \param[in] control \ref ARM_USART_MODEM_CONTROL
- \return \ref execution_status
-
- \fn ARM_USART_MODEM_STATUS ARM_USART_GetModemStatus (void)
- \brief Get USART Modem Status lines state.
- \return modem status \ref ARM_USART_MODEM_STATUS
-
- \fn void ARM_USART_SignalEvent (uint32_t event)
- \brief Signal USART Events.
- \param[in] event \ref USART_events notification mask
- \return none
-*/
-
-typedef void (*ARM_USART_SignalEvent_t) (uint32_t event); ///< Pointer to \ref ARM_USART_SignalEvent : Signal USART Event.
-
-
-/**
-\brief USART Device Driver Capabilities.
-*/
-typedef struct _ARM_USART_CAPABILITIES {
- uint32_t asynchronous : 1; ///< supports UART (Asynchronous) mode
- uint32_t synchronous_master : 1; ///< supports Synchronous Master mode
- uint32_t synchronous_slave : 1; ///< supports Synchronous Slave mode
- uint32_t single_wire : 1; ///< supports UART Single-wire mode
- uint32_t irda : 1; ///< supports UART IrDA mode
- uint32_t smart_card : 1; ///< supports UART Smart Card mode
- uint32_t smart_card_clock : 1; ///< Smart Card Clock generator available
- uint32_t flow_control_rts : 1; ///< RTS Flow Control available
- uint32_t flow_control_cts : 1; ///< CTS Flow Control available
- uint32_t event_tx_complete : 1; ///< Transmit completed event: \ref ARM_USART_EVENT_TX_COMPLETE
- uint32_t event_rx_timeout : 1; ///< Signal receive character timeout event: \ref ARM_USART_EVENT_RX_TIMEOUT
- uint32_t rts : 1; ///< RTS Line: 0=not available, 1=available
- uint32_t cts : 1; ///< CTS Line: 0=not available, 1=available
- uint32_t dtr : 1; ///< DTR Line: 0=not available, 1=available
- uint32_t dsr : 1; ///< DSR Line: 0=not available, 1=available
- uint32_t dcd : 1; ///< DCD Line: 0=not available, 1=available
- uint32_t ri : 1; ///< RI Line: 0=not available, 1=available
- uint32_t event_cts : 1; ///< Signal CTS change event: \ref ARM_USART_EVENT_CTS
- uint32_t event_dsr : 1; ///< Signal DSR change event: \ref ARM_USART_EVENT_DSR
- uint32_t event_dcd : 1; ///< Signal DCD change event: \ref ARM_USART_EVENT_DCD
- uint32_t event_ri : 1; ///< Signal RI change event: \ref ARM_USART_EVENT_RI
- uint32_t reserved : 11; ///< Reserved (must be zero)
-} ARM_USART_CAPABILITIES;
-
-
-/**
-\brief Access structure of the USART Driver.
-*/
-typedef struct _ARM_DRIVER_USART {
- ARM_DRIVER_VERSION (*GetVersion) (void); ///< Pointer to \ref ARM_USART_GetVersion : Get driver version.
- ARM_USART_CAPABILITIES (*GetCapabilities) (void); ///< Pointer to \ref ARM_USART_GetCapabilities : Get driver capabilities.
- int32_t (*Initialize) (ARM_USART_SignalEvent_t cb_event); ///< Pointer to \ref ARM_USART_Initialize : Initialize USART Interface.
- int32_t (*Uninitialize) (void); ///< Pointer to \ref ARM_USART_Uninitialize : De-initialize USART Interface.
- int32_t (*PowerControl) (ARM_POWER_STATE state); ///< Pointer to \ref ARM_USART_PowerControl : Control USART Interface Power.
- int32_t (*Send) (const void *data, uint32_t num); ///< Pointer to \ref ARM_USART_Send : Start sending data to USART transmitter.
- int32_t (*Receive) ( void *data, uint32_t num); ///< Pointer to \ref ARM_USART_Receive : Start receiving data from USART receiver.
- int32_t (*Transfer) (const void *data_out,
- void *data_in,
- uint32_t num); ///< Pointer to \ref ARM_USART_Transfer : Start sending/receiving data to/from USART.
- uint32_t (*GetTxCount) (void); ///< Pointer to \ref ARM_USART_GetTxCount : Get transmitted data count.
- uint32_t (*GetRxCount) (void); ///< Pointer to \ref ARM_USART_GetRxCount : Get received data count.
- int32_t (*Control) (uint32_t control, uint32_t arg); ///< Pointer to \ref ARM_USART_Control : Control USART Interface.
- ARM_USART_STATUS (*GetStatus) (void); ///< Pointer to \ref ARM_USART_GetStatus : Get USART status.
- int32_t (*SetModemControl) (ARM_USART_MODEM_CONTROL control); ///< Pointer to \ref ARM_USART_SetModemControl : Set USART Modem Control line state.
- ARM_USART_MODEM_STATUS (*GetModemStatus) (void); ///< Pointer to \ref ARM_USART_GetModemStatus : Get USART Modem Status lines state.
-} const ARM_DRIVER_USART;
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif /* DRIVER_USART_H_ */