25. lpc17xx_spi Module

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

class robovero.lpc17xx_spi.SPI_CFG_Type(**kwargs)

Bases: robovero.internals.cstruct

SPI configuration structure.

  • Databit: Databit number, should be SPI_DATABIT_x, where x is in range from

    8 - 16

  • CPHA: Clock phase, should be:

    • SPI_CPHA_FIRST: first clock edge
    • SPI_CPHA_SECOND: second clock edge

  • CPOL: Clock polarity, should be:

    • SPI_CPOL_HI: high level
    • SPI_CPOL_LO: low level

  • Mode: SPI mode, should be:

    • SPI_MASTER_MODE: Master mode
    • SPI_SLAVE_MODE: Slave mode

  • DataOrder: Data order, should be:

    • SPI_DATA_MSB_FIRST: MSB first
    • SPI_DATA_LSB_FIRST: LSB first

  • ClockRate: Clock rate,in Hz, should not exceed (SPI peripheral clock)/8

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

    the C reference operator (&).

robovero.lpc17xx_spi.SPI_CheckStatus(inputSPIStatus, SPIStatus)

Checks whether the specified SPI Status flag is set or not via inputSPIStatus parameter.

Args:

  • inputSPIStatus: Value to check status of each flag type. This value is the

    return value from SPI_GetStatus().

  • SPIStatus: Specifies the SPI status flag to check, should be one of:

    • SPI_STAT_ABRT: Slave abort.
    • SPI_STAT_MODF: Mode fault.
    • SPI_STAT_ROVR: Read overrun.
    • SPI_STAT_WCOL: Write collision.
    • SPI_STAT_SPIF: SPI transfer complete.

Return: The new state of SPIStatus (SET or RESET)

robovero.lpc17xx_spi.SPI_ClearIntPending(SPIx)

Clear SPI interrupt flag.

Args:

  • SPIx: SPI peripheral definition, should be LPC_SPI
robovero.lpc17xx_spi.SPI_ConfigStructInit(SPI_InitStruct)

Fills each SPI_InitStruct member with its default value.

  • CPHA = SPI_CPHA_FIRST
  • CPOL = SPI_CPOL_HI
  • ClockRate = 1000000
  • DataOrder = SPI_DATA_MSB_FIRST
  • Databit = SPI_DATABIT_8
  • Mode = SPI_MASTER_MODE

Args:

  • SPI_InitStruct: Pointer to a SPI_CFG_Type structure which will be initialized.
class robovero.lpc17xx_spi.SPI_DATA_SETUP_Type(**kwargs)

Bases: robovero.internals.cstruct

SPI Data configuration structure definitions.

  • tx_data: Pointer to transmit data

  • rx_data: Pointer to transmit data

  • length: Length of transfer data

  • counter: Data counter index

  • status: Current status of SPI activity

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

    the C reference operator (&).

robovero.lpc17xx_spi.SPI_DeInit(SPIx)

De-initializes the SPIx peripheral registers to their reset values.

Args:

  • SPIx: SPI peripheral definition, should be LPC_SPI
robovero.lpc17xx_spi.SPI_GetDataSize(SPIx)

Get data bit size per transfer.

Args:

  • SPIx: SPI peripheral definition, should be LPC_SPI

Return:

  • number of bit per transfer, could be 8-16
robovero.lpc17xx_spi.SPI_GetIntStatus(SPIx)

Checks whether the SPI interrupt flag is set or not.

Args:

  • SPIx: SPI peripheral definition, should be LPC_SPI

Return:

  • The new state of SPI Interrupt Flag (SET or RESET)
robovero.lpc17xx_spi.SPI_GetStatus(SPIx)

Get current value of SPI Status register in SPIx peripheral.

The return value of this function must be used with SPI_CheckStatus() to determine current flag status corresponding to each SPI status type. Because some flags in SPI Status register will be cleared after reading, the next reading SPI Status register could not be correct. So this function used to read SPI status register in one time only, then the return value used to check all flags.

Args:

  • SPIx: SPI peripheral definition, should be LPC_SPI

Return:

  • Current value of SPI Status register in SPI peripheral.
robovero.lpc17xx_spi.SPI_Init(SPIx, SPI_ConfigStruct)

Initializes the SPIx peripheral according to the specified parameters in the UART_ConfigStruct.

Args:

  • SPIx: SPI peripheral definition, should be LPC_SPI

  • SPI_ConfigStruct: Pointer to a SPI_CFG_Type structure that contains the

    configuration information for the specified SPI peripheral.

robovero.lpc17xx_spi.SPI_IntCmd(SPIx, NewState)

Enable or disable SPIx interrupt.

Args:

  • SPIx: SPI peripheral definition, should be LPC_SPI
  • NewState: New state of specified UART interrupt type, should be:
    • ENABLE: Enable this SPI interrupt.
    • DISABLE: Disable this SPI interrupt.
robovero.lpc17xx_spi.SPI_ReadWrite(SPIx, dataCfg, xfType)

Read write data function.

This function can be used in both master and slave mode.

Args:

  • SPIx: SPI peripheral definition, should be LPC_SPI

  • dataCfg: Pointer to a SPI_DATA_SETUP_Type structure that contains specified

    information about transmit data configuration.

  • xfType: Transfer type, should be:

    • SPI_TRANSFER_POLLING: Polling mode
    • SPI_TRANSFER_INTERRUPT: Interrupt mode
Return: Actual Data length has been transferred in polling mode.
In interrupt mode, always return (0). Return (-1) if error.
robovero.lpc17xx_spi.SPI_ReceiveData(SPIx)

Receive a single data from SPIx peripheral.

Args:

  • SPIx: SPI peripheral definition, should be LPC_SPI

Return:

  • Data received (16-bit long)
robovero.lpc17xx_spi.SPI_SPCR_BITS(n)

When bit 2 of this register is 1, this field controls the number of bits per transfer.

robovero.lpc17xx_spi.SPI_SendData(SPIx, Data)

Transmit a single data through SPIx peripheral.

Args:

  • SPIx: SPI peripheral definition, should be LPC_SPI

  • Data: Data to transmit (must be 16 or 8-bit long, this depend on SPI data bit

    number configured)

robovero.lpc17xx_spi.SPI_SetClock(SPIx, target_clock)

Setup clock rate for SPI device.

Args:

  • SPIx: SPI peripheral definition, should be LPC_SPI
  • target_clock: clock of SPI (Hz)
class robovero.lpc17xx_spi.SPI_TRANSFER_Type

SPI Transfer Type definitions.

  • SPI_TRANSFER_POLLING: Polling transfer
  • SPI_TRANSFER_INTERRUPT: Interrupt transfer
SPI_TRANSFER_INTERRUPT = 1
SPI_TRANSFER_POLLING = 0