begriffs open source - cmsis/blob - CMSIS/Driver/Include/Driver_I2C.h

   1 /*
   2  * Copyright (c) 2013-2020 ARM Limited. All rights reserved.
   3  *
   4  * SPDX-License-Identifier: Apache-2.0
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the License); you may
   7  * not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  * www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an AS IS BASIS, WITHOUT
  14  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  * $Date:        24. January 2020
  19  * $Revision:    V2.4
  20  *
  21  * Project:      I2C (Inter-Integrated Circuit) Driver definitions
  22  */
  23
  24 /* History:
  25  *  Version 2.4
  26  *    Removed volatile from ARM_I2C_STATUS
  27  *  Version 2.3
  28  *    ARM_I2C_STATUS made volatile
  29  *  Version 2.2
  30  *    Removed function ARM_I2C_MasterTransfer in order to simplify drivers
  31  *      and added back parameter "xfer_pending" to functions
  32  *      ARM_I2C_MasterTransmit and ARM_I2C_MasterReceive
  33  *  Version 2.1
  34  *    Added function ARM_I2C_MasterTransfer and removed parameter "xfer_pending"
  35  *      from functions ARM_I2C_MasterTransmit and ARM_I2C_MasterReceive
  36  *    Added function ARM_I2C_GetDataCount
  37  *    Removed flag "address_nack" from ARM_I2C_STATUS
  38  *    Replaced events ARM_I2C_EVENT_MASTER_DONE and ARM_I2C_EVENT_SLAVE_DONE
  39  *      with event ARM_I2C_EVENT_TRANSFER_DONE
  40  *    Added event ARM_I2C_EVENT_TRANSFER_INCOMPLETE
  41  *    Removed parameter "arg" from function ARM_I2C_SignalEvent
  42  *  Version 2.0
  43  *    New simplified driver:
  44  *      complexity moved to upper layer (especially data handling)
  45  *      more unified API for different communication interfaces
  46  *    Added:
  47  *      Slave Mode
  48  *    Changed prefix ARM_DRV -> ARM_DRIVER
  49  *  Version 1.10
  50  *    Namespace prefix ARM_ added
  51  *  Version 1.00
  52  *    Initial release
  53  */
  54
  55 #ifndef DRIVER_I2C_H_
  56 #define DRIVER_I2C_H_
  57
  58 #ifdef  __cplusplus
  59 extern "C"
  60 {
  61 #endif
  62
  63 #include "Driver_Common.h"
  64
  65 #define ARM_I2C_API_VERSION ARM_DRIVER_VERSION_MAJOR_MINOR(2,4)  /* API version */
  66
  67
  68 /****** I2C Control Codes *****/
  69
  70 #define ARM_I2C_OWN_ADDRESS             (0x01)      ///< Set Own Slave Address; arg = address
  71 #define ARM_I2C_BUS_SPEED               (0x02)      ///< Set Bus Speed; arg = speed
  72 #define ARM_I2C_BUS_CLEAR               (0x03)      ///< Execute Bus clear: send nine clock pulses
  73 #define ARM_I2C_ABORT_TRANSFER          (0x04)      ///< Abort Master/Slave Transmit/Receive
  74
  75 /*----- I2C Bus Speed -----*/
  76 #define ARM_I2C_BUS_SPEED_STANDARD      (0x01)      ///< Standard Speed (100kHz)
  77 #define ARM_I2C_BUS_SPEED_FAST          (0x02)      ///< Fast Speed     (400kHz)
  78 #define ARM_I2C_BUS_SPEED_FAST_PLUS     (0x03)      ///< Fast+ Speed    (  1MHz)
  79 #define ARM_I2C_BUS_SPEED_HIGH          (0x04)      ///< High Speed     (3.4MHz)
  80
  81
  82 /****** I2C Address Flags *****/
  83
  84 #define ARM_I2C_ADDRESS_10BIT           (0x0400)    ///< 10-bit address flag
  85 #define ARM_I2C_ADDRESS_GC              (0x8000)    ///< General Call flag
  86
  87
  88 /**
  89 \brief I2C Status
  90 */
  91 typedef struct _ARM_I2C_STATUS {
  92   uint32_t busy             : 1;        ///< Busy flag
  93   uint32_t mode             : 1;        ///< Mode: 0=Slave, 1=Master
  94   uint32_t direction        : 1;        ///< Direction: 0=Transmitter, 1=Receiver
  95   uint32_t general_call     : 1;        ///< General Call indication (cleared on start of next Slave operation)
  96   uint32_t arbitration_lost : 1;        ///< Master lost arbitration (cleared on start of next Master operation)
  97   uint32_t bus_error        : 1;        ///< Bus error detected (cleared on start of next Master/Slave operation)
  98   uint32_t reserved         : 26;
  99 } ARM_I2C_STATUS;
 100
 101
 102 /****** I2C Event *****/
 103 #define ARM_I2C_EVENT_TRANSFER_DONE       (1UL << 0)  ///< Master/Slave Transmit/Receive finished
 104 #define ARM_I2C_EVENT_TRANSFER_INCOMPLETE (1UL << 1)  ///< Master/Slave Transmit/Receive incomplete transfer
 105 #define ARM_I2C_EVENT_SLAVE_TRANSMIT      (1UL << 2)  ///< Addressed as Slave Transmitter but transmit operation is not set.
 106 #define ARM_I2C_EVENT_SLAVE_RECEIVE       (1UL << 3)  ///< Addressed as Slave Receiver but receive operation is not set.
 107 #define ARM_I2C_EVENT_ADDRESS_NACK        (1UL << 4)  ///< Address not acknowledged from Slave
 108 #define ARM_I2C_EVENT_GENERAL_CALL        (1UL << 5)  ///< Slave addressed with general call address
 109 #define ARM_I2C_EVENT_ARBITRATION_LOST    (1UL << 6)  ///< Master lost arbitration
 110 #define ARM_I2C_EVENT_BUS_ERROR           (1UL << 7)  ///< Bus error detected (START/STOP at illegal position)
 111 #define ARM_I2C_EVENT_BUS_CLEAR           (1UL << 8)  ///< Bus clear finished
 112
 113
 114 // Function documentation
 115 /**
 116   \fn          ARM_DRIVER_VERSION ARM_I2C_GetVersion (void)
 117   \brief       Get driver version.
 118   \return      \ref ARM_DRIVER_VERSION
 119
 120   \fn          ARM_I2C_CAPABILITIES ARM_I2C_GetCapabilities (void)
 121   \brief       Get driver capabilities.
 122   \return      \ref ARM_I2C_CAPABILITIES
 123
 124   \fn          int32_t ARM_I2C_Initialize (ARM_I2C_SignalEvent_t cb_event)
 125   \brief       Initialize I2C Interface.
 126   \param[in]   cb_event  Pointer to \ref ARM_I2C_SignalEvent
 127   \return      \ref execution_status
 128
 129   \fn          int32_t ARM_I2C_Uninitialize (void)
 130   \brief       De-initialize I2C Interface.
 131   \return      \ref execution_status
 132
 133   \fn          int32_t ARM_I2C_PowerControl (ARM_POWER_STATE state)
 134   \brief       Control I2C Interface Power.
 135   \param[in]   state  Power state
 136   \return      \ref execution_status
 137
 138   \fn          int32_t ARM_I2C_MasterTransmit (uint32_t addr, const uint8_t *data, uint32_t num, bool xfer_pending)
 139   \brief       Start transmitting data as I2C Master.
 140   \param[in]   addr          Slave address (7-bit or 10-bit)
 141   \param[in]   data          Pointer to buffer with data to transmit to I2C Slave
 142   \param[in]   num           Number of data bytes to transmit
 143   \param[in]   xfer_pending  Transfer operation is pending - Stop condition will not be generated
 144   \return      \ref execution_status
 145
 146   \fn          int32_t ARM_I2C_MasterReceive (uint32_t addr, uint8_t *data, uint32_t num, bool xfer_pending)
 147   \brief       Start receiving data as I2C Master.
 148   \param[in]   addr          Slave address (7-bit or 10-bit)
 149   \param[out]  data          Pointer to buffer for data to receive from I2C Slave
 150   \param[in]   num           Number of data bytes to receive
 151   \param[in]   xfer_pending  Transfer operation is pending - Stop condition will not be generated
 152   \return      \ref execution_status
 153
 154   \fn          int32_t ARM_I2C_SlaveTransmit (const uint8_t *data, uint32_t num)
 155   \brief       Start transmitting data as I2C Slave.
 156   \param[in]   data  Pointer to buffer with data to transmit to I2C Master
 157   \param[in]   num   Number of data bytes to transmit
 158   \return      \ref execution_status
 159
 160   \fn          int32_t ARM_I2C_SlaveReceive (uint8_t *data, uint32_t num)
 161   \brief       Start receiving data as I2C Slave.
 162   \param[out]  data  Pointer to buffer for data to receive from I2C Master
 163   \param[in]   num   Number of data bytes to receive
 164   \return      \ref execution_status
 165
 166   \fn          int32_t ARM_I2C_GetDataCount (void)
 167   \brief       Get transferred data count.
 168   \return      number of data bytes transferred; -1 when Slave is not addressed by Master
 169
 170   \fn          int32_t ARM_I2C_Control (uint32_t control, uint32_t arg)
 171   \brief       Control I2C Interface.
 172   \param[in]   control  Operation
 173   \param[in]   arg      Argument of operation (optional)
 174   \return      \ref execution_status
 175
 176   \fn          ARM_I2C_STATUS ARM_I2C_GetStatus (void)
 177   \brief       Get I2C status.
 178   \return      I2C status \ref ARM_I2C_STATUS
 179
 180   \fn          void ARM_I2C_SignalEvent (uint32_t event)
 181   \brief       Signal I2C Events.
 182   \param[in]   event  \ref I2C_events notification mask
 183 */
 184
 185 typedef void (*ARM_I2C_SignalEvent_t) (uint32_t event);  ///< Pointer to \ref ARM_I2C_SignalEvent : Signal I2C Event.
 186
 187
 188 /**
 189 \brief I2C Driver Capabilities.
 190 */
 191 typedef struct _ARM_I2C_CAPABILITIES {
 192   uint32_t address_10_bit : 1;          ///< supports 10-bit addressing
 193   uint32_t reserved       : 31;         ///< Reserved (must be zero)
 194 } ARM_I2C_CAPABILITIES;
 195
 196
 197 /**
 198 \brief Access structure of the I2C Driver.
 199 */
 200 typedef struct _ARM_DRIVER_I2C {
 201   ARM_DRIVER_VERSION   (*GetVersion)     (void);                                                                ///< Pointer to \ref ARM_I2C_GetVersion : Get driver version.
 202   ARM_I2C_CAPABILITIES (*GetCapabilities)(void);                                                                ///< Pointer to \ref ARM_I2C_GetCapabilities : Get driver capabilities.
 203   int32_t              (*Initialize)     (ARM_I2C_SignalEvent_t cb_event);                                      ///< Pointer to \ref ARM_I2C_Initialize : Initialize I2C Interface.
 204   int32_t              (*Uninitialize)   (void);                                                                ///< Pointer to \ref ARM_I2C_Uninitialize : De-initialize I2C Interface.
 205   int32_t              (*PowerControl)   (ARM_POWER_STATE state);                                               ///< Pointer to \ref ARM_I2C_PowerControl : Control I2C Interface Power.
 206   int32_t              (*MasterTransmit) (uint32_t addr, const uint8_t *data, uint32_t num, bool xfer_pending); ///< Pointer to \ref ARM_I2C_MasterTransmit : Start transmitting data as I2C Master.
 207   int32_t              (*MasterReceive)  (uint32_t addr,       uint8_t *data, uint32_t num, bool xfer_pending); ///< Pointer to \ref ARM_I2C_MasterReceive : Start receiving data as I2C Master.
 208   int32_t              (*SlaveTransmit)  (               const uint8_t *data, uint32_t num);                    ///< Pointer to \ref ARM_I2C_SlaveTransmit : Start transmitting data as I2C Slave.
 209   int32_t              (*SlaveReceive)   (                     uint8_t *data, uint32_t num);                    ///< Pointer to \ref ARM_I2C_SlaveReceive : Start receiving data as I2C Slave.
 210   int32_t              (*GetDataCount)   (void);                                                                ///< Pointer to \ref ARM_I2C_GetDataCount : Get transferred data count.
 211   int32_t              (*Control)        (uint32_t control, uint32_t arg);                                      ///< Pointer to \ref ARM_I2C_Control : Control I2C Interface.
 212   ARM_I2C_STATUS       (*GetStatus)      (void);                                                                ///< Pointer to \ref ARM_I2C_GetStatus : Get I2C status.
 213 } const ARM_DRIVER_I2C;
 214
 215 #ifdef  __cplusplus
 216 }
 217 #endif
 218
 219 #endif /* DRIVER_I2C_H_ */