Frank 26080115 / LPC1700CMSIS_Lib

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Embed: (wiki syntax)

« Back to documentation index

I2C Public Functions
Functions

I2C Public Functions
[I2C]

Functions

void I2C_Init (LPC_I2C_TypeDef *I2Cx, uint32_t clockrate)
 Initializes the I2Cx peripheral with specified parameter.
void I2C_DeInit (LPC_I2C_TypeDef *I2Cx)
 De-initializes the I2C peripheral registers to their default reset values.
void I2C_Cmd (LPC_I2C_TypeDef *I2Cx, FunctionalState NewState)
 Enable or disable I2C peripheral's operation.
void I2C_IntCmd (LPC_I2C_TypeDef *I2Cx, Bool NewState)
 Enable/Disable interrupt for I2C peripheral.
void I2C_MasterHandler (LPC_I2C_TypeDef *I2Cx)
 General Master Interrupt handler for I2C peripheral.
void I2C_SlaveHandler (LPC_I2C_TypeDef *I2Cx)
 General Slave Interrupt handler for I2C peripheral.
Status I2C_MasterTransferData (LPC_I2C_TypeDef *I2Cx, I2C_M_SETUP_Type *TransferCfg,\I2C_TRANSFER_OPT_Type Opt)
 Transmit and Receive data in master mode.
Status I2C_SlaveTransferData (LPC_I2C_TypeDef *I2Cx, I2C_S_SETUP_Type *TransferCfg,\I2C_TRANSFER_OPT_Type Opt)
 Receive and Transmit data in slave mode.
void I2C_SetOwnSlaveAddr (LPC_I2C_TypeDef *I2Cx, I2C_OWNSLAVEADDR_CFG_Type *OwnSlaveAddrConfigStruct)
 Set Own slave address in I2C peripheral corresponding to parameter specified in OwnSlaveAddrConfigStruct.
void I2C_MonitorModeConfig (LPC_I2C_TypeDef *I2Cx, uint32_t MonitorCfgType, FunctionalState NewState)
 Configures functionality in I2C monitor mode.
void I2C_MonitorModeCmd (LPC_I2C_TypeDef *I2Cx, FunctionalState NewState)
 Enable/Disable I2C monitor mode.
uint8_t I2C_MonitorGetDatabuffer (LPC_I2C_TypeDef *I2Cx)
 Get data from I2C data buffer in monitor mode.
BOOL_8 I2C_MonitorHandler (LPC_I2C_TypeDef *I2Cx, uint8_t *buffer, uint32_t size)
 Get data from I2C data buffer in monitor mode.
uint32_t I2C_MasterTransferComplete (LPC_I2C_TypeDef *I2Cx)
 Get status of Master Transfer.
uint32_t I2C_SlaveTransferComplete (LPC_I2C_TypeDef *I2Cx)
 Get status of Slave Transfer.

Function Documentation

void I2C_Cmd ( LPC_I2C_TypeDef *  I2Cx,
FunctionalState  NewState 
)

Enable or disable I2C peripheral's operation.

Parameters:
[in]I2CxI2C peripheral selected, should be

  • LPC_I2C0
    • LPC_I2C1
    • LPC_I2C2
[in]NewStateNew State of I2Cx peripheral's operation
Returns:
none

Definition at line 335 of file lpc17xx_i2c.c.

void I2C_DeInit ( LPC_I2C_TypeDef *  I2Cx )

De-initializes the I2C peripheral registers to their default reset values.

Parameters:
[in]I2CxI2C peripheral selected, should be

  • LPC_I2C0
    • LPC_I2C1
    • LPC_I2C2
Returns:
None

Definition at line 302 of file lpc17xx_i2c.c.

void I2C_Init ( LPC_I2C_TypeDef *  I2Cx,
uint32_t  clockrate 
)

Initializes the I2Cx peripheral with specified parameter.

Parameters:
[in]I2CxI2C peripheral selected, should be

  • LPC_I2C0
  • LPC_I2C1
  • LPC_I2C2
[in]clockrateTarget clock rate value to initialized I2C peripheral (Hz)
Returns:
None

Definition at line 254 of file lpc17xx_i2c.c.

void I2C_IntCmd ( LPC_I2C_TypeDef *  I2Cx,
Bool  NewState 
)

Enable/Disable interrupt for I2C peripheral.

Parameters:
[in]I2CxI2C peripheral selected, should be:

  • LPC_I2C0
  • LPC_I2C1
  • LPC_I2C2
[in]NewStateNew State of I2C peripheral interrupt in NVIC core should be:

  • ENABLE: enable interrupt for this I2C peripheral
  • DISABLE: disable interrupt for this I2C peripheral
Returns:
None

Definition at line 362 of file lpc17xx_i2c.c.

void I2C_MasterHandler ( LPC_I2C_TypeDef *  I2Cx )

General Master Interrupt handler for I2C peripheral.

Parameters:
[in]I2CxI2C peripheral selected, should be:

  • LPC_I2C
  • LPC_I2C1
  • LPC_I2C2
Returns:
None

Definition at line 406 of file lpc17xx_i2c.c.

uint32_t I2C_MasterTransferComplete ( LPC_I2C_TypeDef *  I2Cx )

Get status of Master Transfer.

Parameters:
[in]I2CxI2C peripheral selected, should be:

  • LPC_I2C0
    • LPC_I2C1
    • LPC_I2C2
Returns:
Master transfer status, could be:
  • TRUE master transfer completed
  • FALSE master transfer have not completed yet

Definition at line 1335 of file lpc17xx_i2c.c.

Status I2C_MasterTransferData ( LPC_I2C_TypeDef *  I2Cx,
I2C_M_SETUP_Type *  TransferCfg,
\I2C_TRANSFER_OPT_Type  Opt 
)

Transmit and Receive data in master mode.

Parameters:
[in]I2CxI2C peripheral selected, should be:

  • LPC_I2C0
    • LPC_I2C1
    • LPC_I2C2
[in]TransferCfgPointer to a I2C_M_SETUP_Type structure that contains specified information about the configuration for master transfer.
[in]Opta I2C_TRANSFER_OPT_Type type that selected for interrupt or polling mode.
Returns:
SUCCESS or ERROR

Note:

  • In case of using I2C to transmit data only, either transmit length set to 0 or transmit data pointer set to NULL.
  • In case of using I2C to receive data only, either receive length set to 0 or receive data pointer set to NULL.
  • In case of using I2C to transmit followed by receive data, transmit length, transmit data pointer, receive length and receive data pointer should be set corresponding.

Definition at line 771 of file lpc17xx_i2c.c.

uint8_t I2C_MonitorGetDatabuffer ( LPC_I2C_TypeDef *  I2Cx )

Get data from I2C data buffer in monitor mode.

Parameters:
[in]I2CxI2C peripheral selected, should be

  • LPC_I2C0
    • LPC_I2C1
    • LPC_I2C2
Returns:
None Note: In monitor mode, the I2C module may lose the ability to stretch the clock (stall the bus) if the ENA_SCL bit is not set. This means that the processor will have a limited amount of time to read the contents of the data received on the bus. If the processor reads the I2DAT shift register, as it ordinarily would, it could have only one bit-time to respond to the interrupt before the received data is overwritten by new data.

Definition at line 1290 of file lpc17xx_i2c.c.

BOOL_8 I2C_MonitorHandler ( LPC_I2C_TypeDef *  I2Cx,
uint8_t *  buffer,
uint32_t  size 
)

Get data from I2C data buffer in monitor mode.

Parameters:
[in]I2CxI2C peripheral selected, should be

  • LPC_I2C0
    • LPC_I2C1
    • LPC_I2C2
Returns:
None Note: In monitor mode, the I2C module may lose the ability to stretch the clock (stall the bus) if the ENA_SCL bit is not set. This means that the processor will have a limited amount of time to read the contents of the data received on the bus. If the processor reads the I2DAT shift register, as it ordinarily would, it could have only one bit-time to respond to the interrupt before the received data is overwritten by new data.

Definition at line 1311 of file lpc17xx_i2c.c.

void I2C_MonitorModeCmd ( LPC_I2C_TypeDef *  I2Cx,
FunctionalState  NewState 
)

Enable/Disable I2C monitor mode.

Parameters:
[in]I2CxI2C peripheral selected, should be

  • LPC_I2C0
    • LPC_I2C1
    • LPC_I2C2
[in]NewStateNew State of this function, should be:

  • ENABLE: Enable monitor mode.
  • DISABLE: Disable monitor mode.
Returns:
None

Definition at line 1255 of file lpc17xx_i2c.c.

void I2C_MonitorModeConfig ( LPC_I2C_TypeDef *  I2Cx,
uint32_t  MonitorCfgType,
FunctionalState  NewState 
)

Configures functionality in I2C monitor mode.

Parameters:
[in]I2CxI2C peripheral selected, should be

  • LPC_I2C0
    • LPC_I2C1
    • LPC_I2C2
[in]MonitorCfgTypeMonitor Configuration type, should be:

  • I2C_MONITOR_CFG_SCL_OUTPUT: I2C module can 'stretch' the clock line (hold it low) until it has had time to respond to an I2C interrupt.
  • I2C_MONITOR_CFG_MATCHALL: When this bit is set to '1' and the I2C is in monitor mode, an interrupt will be generated on ANY address received.
[in]NewStateNew State of this function, should be:

  • ENABLE: Enable this function.
  • DISABLE: Disable this function.
Returns:
None

Definition at line 1227 of file lpc17xx_i2c.c.

void I2C_SetOwnSlaveAddr ( LPC_I2C_TypeDef *  I2Cx,
I2C_OWNSLAVEADDR_CFG_Type *  OwnSlaveAddrConfigStruct 
)

Set Own slave address in I2C peripheral corresponding to parameter specified in OwnSlaveAddrConfigStruct.

Parameters:
[in]I2CxI2C peripheral selected, should be

  • LPC_I2C0
    • LPC_I2C1
    • LPC_I2C2
[in]OwnSlaveAddrConfigStructPointer to a I2C_OWNSLAVEADDR_CFG_Type structure that contains the configuration information for the specified I2C slave address.
Returns:
None

Definition at line 1174 of file lpc17xx_i2c.c.

void I2C_SlaveHandler ( LPC_I2C_TypeDef *  I2Cx )

General Slave Interrupt handler for I2C peripheral.

Parameters:
[in]I2CxI2C peripheral selected, should be:

  • LPC_I2C0
  • LPC_I2C1
  • LPC_I2C2
Returns:
None

Definition at line 610 of file lpc17xx_i2c.c.

uint32_t I2C_SlaveTransferComplete ( LPC_I2C_TypeDef *  I2Cx )

Get status of Slave Transfer.

Parameters:
[in]I2CxI2C peripheral selected, should be:

  • LPC_I2C0
  • LPC_I2C1
  • LPC_I2C2
Returns:
Complete status, could be: TRUE/FALSE

Definition at line 1352 of file lpc17xx_i2c.c.

Status I2C_SlaveTransferData ( LPC_I2C_TypeDef *  I2Cx,
I2C_S_SETUP_Type *  TransferCfg,
\I2C_TRANSFER_OPT_Type  Opt 
)

Receive and Transmit data in slave mode.

Parameters:
[in]I2CxI2C peripheral selected, should be

  • LPC_I2C0
    • LPC_I2C1
    • LPC_I2C2
[in]TransferCfgPointer to a I2C_S_SETUP_Type structure that contains specified information about the configuration for master transfer.
[in]OptI2C_TRANSFER_OPT_Type type that selected for interrupt or polling mode.
Returns:
SUCCESS or ERROR

Note: The mode of slave's operation depends on the command sent from master on the I2C bus. If the master send a SLA+W command, this sub-routine will use receive data length and receive data pointer. If the master send a SLA+R command, this sub-routine will use transmit data length and transmit data pointer. If the master issue an repeat start command or a stop command, the slave will enable an time out condition, during time out condition, if there's no activity on I2C bus, the slave will exit, otherwise (i.e. the master send a SLA+R/W), the slave then switch to relevant operation mode. The time out should be used because the return status code can not show difference from stop and repeat start command in slave operation. In case of the expected data length from master is greater than data length that slave can support:

  • In case of reading operation (from master): slave will return I2C_I2DAT_IDLE_CHAR value.
  • In case of writing operation (from master): slave will ignore remain data from master.

Definition at line 983 of file lpc17xx_i2c.c.

Generated on Tue Jul 12 2022 17:33:24 by  doxygen 1.7.2