SPI#

rsi_frame_read#

int16_t rsi_frame_read (uint8_t * pkt_buffer)

Read response for every command and data sent from the module.

This API reads the frame from the host interface.

Returns

• 0 - Success
  

• Non-Zero Failure - Failure
  

Note

• Enable DEBUG_PACKET_EXCHANGE macro for SPI level packet exchange debug prints and MAX_PRINT_PAYLOAD_LEN for configuring number of bytes of payload to print, by default it will print 8 bytes of payload.

rsi_frame_write#

int16_t rsi_frame_write (rsi_frame_desc_t * uFrameDscFrame, uint8_t * payloadparam, uint16_t size_param)

Process a command to the module.

This API writes the frame to the host interface.

Returns

• 0 - Success
  

• Non-Zero value - Failure
  

Note

• Enable DEBUG_PACKET_EXCHANGE macro for SPI level packet exchange debug prints and MAX_PRINT_PAYLOAD_LEN for configuring number of bytes of payload to print, by default it will print 8 bytes of payload.
  

rsi_pre_dsc_rd#

int16_t rsi_pre_dsc_rd (uint8_t * dbuf)

Read a pre-frame descriptor.

Returns

• 0 - Success
  

• Non-Zero value - Failure
  

rsi_pkt_rd#

int16_t rsi_pkt_rd (uint8_t * buf, uint16_t dummy_len, uint16_t total_len)

Read frame descriptor and payload.

Returns

• 0 - Success
  

• Non-Zero value - Failure
  

rsi_spi_frame_dsc_wr#

int16_t rsi_spi_frame_dsc_wr (rsi_frame_desc_t * uFrameDscFrame)

Write the frame descriptor.

Returns

• 0 - Success
  

• Non-Zero value - Failure
  

rsi_spi_frame_data_wr#

int16_t rsi_spi_frame_data_wr (uint16_t bufLen, uint8_t * dBuf, uint16_t tbufLen, uint8_t * tBuf)

Write frame data.

Returns

• 0 - Success
  

• Non-Zero value - Failure
  

rsi_send_c1c2#

int16_t rsi_send_c1c2 (uint8_t c1, uint8_t c2)

Send the C1 and C2 commands. Check response for C1 command, if busy, should retry.

Returns

• 0 - Success
  

• Non-Zero value - Failure
  

rsi_send_c3c4#

int16_t rsi_send_c3c4 (uint8_t c3, uint8_t c4)

Send the C3 and C4 commands.

Returns

• 0 - Success
  

• Non-Zero value - Failure
  

Note

• A succesful rsi_send_c1c2() is required before this function.

rsi_spi_wait_start_token#

int16_t rsi_spi_wait_start_token (uint32_t timeout, uint8_t mode)

Loop read the SPI until a start token (i.e., 0x55) is received.

Returns

• 0 - Success
  

• Non-Zero value - Failure
  

Note

• Should issue read commands before using this function

rsi_set_intr_mask#

int16_t rsi_set_intr_mask (uint8_t interruptMask)

Set the interrupt mask register of the module.

Returns

• 0 - Success
  

• Non-Zero value - Failure
  

rsi_set_intr_type#

int16_t rsi_set_intr_type (uint32_t interruptMaskVal)

Set the interrupt type of the module.

Returns

• 0 - Success
  

• Non-Zero value - Failure
  

rsi_clear_interrupt#

int16_t rsi_clear_interrupt (uint8_t interruptClear)

Clear the interrupt register.

Returns

• 0 - Success
  

• Non-Zero value - Failure
  

rsi_device_interrupt_status#

int16_t rsi_device_interrupt_status (uint8_t * int_status)

Read the SPI interrupt register status.

This API reads the status register of the host interface layer to validate the interrupt received.

Returns

• 0 - Success
  

• Non-Zero value - Failure
  

rsi_spi_pkt_len#

int16_t rsi_spi_pkt_len (uint16_t * length)

Read the length of the incoming packet to the module.

Returns

• 0 - Success
  

• Non-Zero value - Failure
  

rsi_spi_high_speed_enable#

int16_t rsi_spi_high_speed_enable (void )

Configure the module SPI interface to high speed mode.

Returns

• 0 - Success
  

• Non-Zero value - Failure
  

Note

• This API should be called only if the SPI clock frequency is more than 25 MHz and shouldn't be called otherwise.

• SPI initialization has to be done in low-speed mode. After device SPI is configured to high-speed mode using this API,
  rsi_switch_to_high_clk_freq() will be executed to configure the host SPI to a frequency that is more than 25 MHz.
  The latter API has to be ported by the user to implement the host clock switch.

rsi_spi_iface_init#

int16_t rsi_spi_iface_init (void )

Initialize the SPI secondary device interface of the module.

Returns

• 0 - Success
  

• Non-Zero value - Failure
  

rsi_ulp_wakeup_init#

void rsi_ulp_wakeup_init (void )

Initialize the SPI secondary device interface of the module on ULP wakeup.

Returns

• Void

rsi_mem_wr#

int16_t rsi_mem_wr (uint32_t addr, uint16_t len, uint8_t * dBuf)

Memory write to the module.

This API writes contents of dBuf buffer to the device memory address addr for the length len.

Returns

• 0 - Success
  

• Non-Zero value - Failure
  

rsi_mem_rd#

int16_t rsi_mem_rd (uint32_t addr, uint16_t len, uint8_t * dBuf)

Memory read from the module.

This API reads the device memory contents present at the address addr into the dBuf buffer for the length len.

Returns

• 0 - Success
  

• Non-Zero value - Failure
  

rsi_reg_rd#

int16_t rsi_reg_rd (uint8_t regAddr, uint8_t * dBuf)

Read from a register in the module from the address specified.

This API reads the content of the host interface register regAddr to the buffer dBuf.

Returns

• 0 - Success
  

• Non-Zero value - Failure
  

rsi_reg_rd2#

int16_t rsi_reg_rd2 (uint8_t regAddr, uint16_t * dBuf)

Read from a register in the wlan module from the address specified.

Returns

• 0 - Success
  

• Non-Zero value - Failure
  

rsi_reg_wr#

int16_t rsi_reg_wr (uint8_t regAddr, uint8_t * dBuf)

Write to a register in the module with an address specified.

This API writes the content provided by dBuf to the host interface register regAddr.

Returns

• 0 - Success
  

• Non-Zero value - Failure