Api Functions In The Esp8266 Demo - Espressif ESP8266 Technical Reference

!
sub_sof: the flag of the start of the sub-frame. It is used to distinguish different
•
AMPDU sub-frames. It is only used when the MAC is sending packets.
length[11:0]: actual size of the buffer.
•
size[11:0]: total size of the buffer.
•
buf_ptr[31:0]: starting address of the buffer.
•
next_link_ptr[31:0]: starting address of the next discripter. When the MAC is receiving
•
frames, the value is 0, indicating that there is no empty buffer to receive the frames.

3.3.3. API Functions in The ESP8266 DEMO

1. void sdio_slave_init(void)
Function: Initialise the SDIO module, including initialising the status register, initialising the
Rx and Tx registration linked list, configuring the communication interrupt line mode,
configuring packet-sending/receiving interruption, and registering the interrupt service
routine, etc.
2. void sdio_slave_isr(void *para)
Function and trigger condition: The SDIO interrupt processing function; this function will be
triggered when the SDIO successfully receives or sends a packet. in DEMO, all the
ESP8266 testing procedures are completed in the interrupt processing function. All the
processing procedures of the registration linked lists, status registers and data during the
communication process can be found in this function.
3. void rx_buff_load_done(uint16 rx_len)
Function: When rx_buffer receives new packets, this function should be called to change
the status of the new packets to "to be read". This function contains related operations of
the software/hardware of the registration linked list, and the status register. In DEMO, this
function will be called in the interrupt service routine.
Parameter: rx_len: actual length of the new packet (unit: byte).
4. void tx_buff_handle_done(void)
Function: When data in tx_buffer has been processed, this function should be called to
change the SDIO status to "sent" in order to receive the next packet. This function
contains related operations of the software/hardware of the registration linked list, and the
status register. In DEMO, this function will be called in the interrupt service routine.
5. void rx_buff_read_done(void)
Function: When data in rx_buffe has been read, this function should be called to change
the SDIO status to "non-readable". This function contains related operations of the status
register, and should be called at the beginning of the RX_EOF interrupt service.
6. void tx_buff_write_done(void)
Function: When tx_buffer receives new packets, this function should be called to change
the SDIO status to "non-writable". This function contains related operations of the status
register, and should be called at the beginning of the TX_EOF interrupt service.
Espressif
3. SPI Compatibility Mode User Guide
17 86 ! /! 2016.05