16. lpc17xx_i2c Module

I2C client library functions. Find implementation details in LPC17xx CMSIS-Compliant Standard Peripheral Firmware Driver Library documentation.

robovero.lpc17xx_i2c.I2C_Cmd(I2Cx, NewState)

Enable or disable I2C peripheral’s operation.

Args:

  • I2Cx: I2C peripheral selected, should be
    • LPC_I2C0
    • LPC_I2C1
    • LPC_I2C2
  • NewState: New State of I2Cx peripheral’s operation
robovero.lpc17xx_i2c.I2C_DeInit(I2Cx)

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

Args:

  • I2Cx: I2C peripheral selected, should be
    • LPC_I2C0
    • LPC_I2C1
    • LPC_I2C2
robovero.lpc17xx_i2c.I2C_I2MASK_MASK(n)

I2C Mask Register mask field.

robovero.lpc17xx_i2c.I2C_Init(I2Cx, clockrate)

Initializes the I2Cx peripheral with specified parameter.

Args

  • I2Cx: I2C peripheral selected, should be
    • LPC_I2C0
    • LPC_I2C1
    • LPC_I2C2
  • clockrate: Target clock rate value to initialized I2C peripheral (Hz)
robovero.lpc17xx_i2c.I2C_IntCmd(I2Cx, NewState)

Enable/Disable interrupt for I2C peripheral.

Args:

  • I2Cx: I2C peripheral selected, should be
    • LPC_I2C0
    • LPC_I2C1
    • LPC_I2C2
  • NewState: New State of I2C peripheral interrupt in NVIC core should be:
    • ENABLE: enable interrupt for this I2C peripheral
    • DISABLE: disable interrupt for this I2C peripheral
class robovero.lpc17xx_i2c.I2C_M_SETUP_Type(**kwargs)

Bases: robovero.internals.cstruct

Master transfer setup data structure definitions.

  • sl_addr7bit: Slave address in 7bit mode

  • tx_data: Pointer to Transmit data - NULL if data transmit is not used

  • tx_length: Transmit data length - 0 if data transmit is not used

  • tx_count: Current Transmit data counter

  • rx_data: Pointer to Receive data - NULL if data receive is not used

  • rx_length: Receive data length - 0 if data receive is not used

  • rx_count: Current Receive data counter

  • retransmissions_max: Max Re-Transmission value

  • retransmissions_count: Current Re-Transmission counter

  • status: Current status of I2C activity

  • callback: Pointer to Call back function when transmission complete used in

    interrupt transfer mode

  • ptr: LPC1769 memory address where structure is stored. Use this in place of

    the C reference operator (&).

robovero.lpc17xx_i2c.I2C_MasterHandler(I2Cx)

General Master Interrupt handler for I2C peripheral.

Args:

  • I2Cx: I2C peripheral selected, should be
    • LPC_I2C0
    • LPC_I2C1
    • LPC_I2C2
robovero.lpc17xx_i2c.I2C_MasterTransferComplete(I2Cx)

Get status of Master Transfer.

Args:

  • I2Cx: I2C peripheral selected, should be
    • LPC_I2C0
    • LPC_I2C1
    • LPC_I2C2

Return:

  • Master transfer status, could be:
    • TRUE: master transfer completed
    • FALSE: master transfer have not completed yet
robovero.lpc17xx_i2c.I2C_MasterTransferData(I2Cx, TransferCfg, Opt)

Transmit and Receive data in master mode.

Args:

  • I2Cx: I2C peripheral selected, should be

    • LPC_I2C0
    • LPC_I2C1
    • LPC_I2C2
  • TransferCfg: Pointer to a I2C_M_SETUP_Type structure that contains specified

    information about the configuration for master transfer.

  • Opt: a I2C_TRANSFER_OPT_Type type that selected for interrupt or polling mode

Return:

  • SUCCESS or ERROR
robovero.lpc17xx_i2c.I2C_MonitorGetDatabuffer(I2Cx)

Get data from I2C data buffer in monitor mode.

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.

Args:

  • I2Cx: I2C peripheral selected, should be
    • LPC_I2C0
    • LPC_I2C1
    • LPC_I2C2

Return:

  • (uint8_t)
robovero.lpc17xx_i2c.I2C_MonitorHandler(I2Cx, buffer, size)

Args:

  • I2Cx: I2C peripheral selected, should be
    • LPC_I2C0
    • LPC_I2C1
    • LPC_I2C2

TODO: Add Args documentation for buffer, size

robovero.lpc17xx_i2c.I2C_MonitorModeCmd(I2Cx, NewState)

Enable/Disable I2C monitor mode.

Args:

  • I2Cx: I2C peripheral selected, should be
    • LPC_I2C0
    • LPC_I2C1
    • LPC_I2C2
  • NewState: New State of this function, should be:
    • ENABLE: Enable monitor mode.
    • DISABLE: Disable monitor mode.
robovero.lpc17xx_i2c.I2C_MonitorModeConfig(I2Cx, MonitorCfgType, NewState)

Configures functionality in I2C monitor mode.

Args:

  • I2Cx: I2C peripheral selected, should be

    • LPC_I2C0
    • LPC_I2C1
    • LPC_I2C2

  • MonitorCfgType: Monitor 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.

  • NewState: New State of this function, should be:

    • ENABLE: Enable this function.
    • DISABLE: Disable this function.
class robovero.lpc17xx_i2c.I2C_OWNSLAVEADDR_CFG_Type(**kwargs)

Bases: robovero.internals.cstruct

I2C Own slave address setting structure.

  • SlaveAddrChannel: Slave Address channel in I2C control, should be in range

    from 0..3

  • SlaveAddr_7bit: Value of 7-bit slave address

  • GeneralCallState: Enable/Disable General Call Functionality when I2C control

    being in Slave mode, should be: ENABLE: Enable General Call function. DISABLE: Disable General Call function.

  • SlaveAddrMaskValue: Any bit in this 8-bit value (bit 7:1) which is set to ‘1’

    will cause an automatic compare on the corresponding bit of the received address when it is compared to the SlaveAddr_7bit value associated with this mask register. In other words, bits in SlaveAddr_7bit value which are masked are not taken into account in determining an address match

  • ptr: LPC1769 memory address where structure is stored. Use this in place of

    the C reference operator (&).

class robovero.lpc17xx_i2c.I2C_S_SETUP_Type(**kwargs)

Bases: robovero.internals.cstruct

Slave transfer setup data structure definitions.

  • tx_data: Pointer to Transmit data - NULL if data transmit is not used

  • tx_length: Transmit data length - 0 if data transmit is not used

  • tx_count: Current Transmit data counter

  • rx_data: Pointer to Receive data - NULL if data receive is not used

  • rx_length: Receive data length - 0 if data receive is not used

  • rx_count: Current Receive data counter

  • status: Current status of I2C activity

  • callback: Pointer to Call back function when transmission complete used in

    interrupt transfer mode

  • ptr: LPC1769 memory address where structure is stored. Use this in place of

    the C reference operator (&).

robovero.lpc17xx_i2c.I2C_SetOwnSlaveAddr(I2Cx, OwnSlaveAddrConfigStruct)

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

Args:

  • I2Cx: I2C peripheral selected, should be

    • LPC_I2C0
    • LPC_I2C1
    • LPC_I2C2
  • OwnSlaveAddrConfigStruct: Pointer to a I2C_OWNSLAVEADDR_CFG_Type structure

    that contains the configuration information for the specified I2C slave address.

robovero.lpc17xx_i2c.I2C_SlaveHandler(I2Cx)

General Slave Interrupt handler for I2C peripheral.

Args:

  • I2Cx: I2C peripheral selected, should be
    • LPC_I2C0
    • LPC_I2C1
    • LPC_I2C2
robovero.lpc17xx_i2c.I2C_SlaveTransferComplete(I2Cx)

Get status of Slave Transfer.

Args:

  • I2Cx: I2C peripheral selected, should be
    • LPC_I2C0
    • LPC_I2C1
    • LPC_I2C2

Return:

  • Complete status, could be: TRUE/FALSE
robovero.lpc17xx_i2c.I2C_SlaveTransferData(I2Cx, TransferCfg, Opt)

Get status of Slave Transfer.

Args:

  • I2Cx: I2C peripheral selected, should be
    • LPC_I2C0
    • LPC_I2C1
    • LPC_I2C2

Return:

  • Complete status, could be: TRUE/FALSE
class robovero.lpc17xx_i2c.I2C_TRANSFER_OPT_Type

Transfer option type definitions.

I2C_TRANSFER_INTERRUPT = 1
I2C_TRANSFER_POLLING = 0
robovero.lpc17xx_i2c.PARAM_I2C_MONITOR_CFG(n)

Macros check I2C monitor configuration type.

robovero.lpc17xx_i2c.PARAM_I2C_SLAVEADDR_CH(n)

Macros check I2C slave address.

robovero.lpc17xx_i2c.PARAM_I2Cx(n)

Macro to determine if it is valid SSP port numbe.