board_modules.h File Reference

Definitions for optional off-board hardware modules that can be used with all ESP8266 boards. More...

Detailed Description

Definitions for optional off-board hardware modules that can be used with all ESP8266 boards.

All ESP8266 boards can be used with different off-board hardware modules. This file contains the default configurations for those external hardware modules that have been tested with the ESP8266 and are preconfigured here. Most of these configurations can be overridden by an application-specific configuration.

The configurations of the respective hardware modules only take place if the corresponding driver modules are used.

Author
Gunar Schorcht gunar.nosp@m.@sch.nosp@m.orcht.nosp@m..net

Definition in file board_modules.h.

#include <stdint.h>
+ Include dependency graph for board_modules.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

ENC28J60 configuration

Configuration for the ENC28J60 interface when module enc28j60 is used.

SPI_DEV(0) is always used for the the module. The only configurations that can be overridden by Application Specific Board Configuration are the CS, INT and RESET signals.

Note
The RESET signal can also be connected to the ESP8266 RST pin to keep an additional GPIO free.
#define ENC28J60_PARAM_SPI   SPI_DEV(0)
 SPI_DEV(0) is used (fixed)
 
#define ENC28J60_PARAM_CS   GPIO4
 ENC28J60 CS signal (can be overridden)
 
#define ENC28J60_PARAM_INT   GPIO9
 ENC28J60 INT signal (can be overridden)
 
#define ENC28J60_PARAM_RESET   GPIO10
 ENC28J60 RESET signal (can be overridden)
 

MRF24J40 configuration

Configuration for the MRF24J40 interface when module mrf24j40 is used.

SPI_DEV(0) is always used for the the module. The only configurations that can be overridden by Application Specific Board Configuration are the CS, INT and RESET signals.

Note
The RESET signal can also be connected to the ESP8266 RST pin to keep an additional GPIO free.
#define MRF24J40_PARAM_SPI   SPI_DEV(0)
 SPI_DEV(0) is used (fixed)
 
#define MRF24J40_PARAM_SPI_CLK   SPI_CLK_1MHZ
 SPI bus speed used (can be overridden)
 
#define MRF24J40_PARAM_CS   GPIO16
 MRF24J40 CS signal (can be overridden)
 
#define MRF24J40_PARAM_INT   GPIO0
 MRF24J40 INT signal (can be overridden)
 
#define MRF24J40_PARAM_RESET   GPIO2
 MRF24J40 RESET signal (can be overridden)
 

SD-Card configuration

Configuration of the SD-Card interface when module sdcard_spi is used.

The SPI interface with the corresponding pins used for the SD-Card interface is fixed. SPI_DEV(0) is always used for the SD-Card. The only configuration that can be overridden by Application Specific Board Configuration is the CS signal. If not defined, the default CS signal of SPI_DEV(0) is used.

#define SDCARD_SPI_PARAM_SPI   SPI_DEV(0)
 SPI_DEV(0) is used (fixed)
 
#define SDCARD_SPI_PARAM_CLK   SPI0_SCK
 SPI_DEV(0) SCK is used (fixed)
 
#define SDCARD_SPI_PARAM_MOSI   SPI0_MOSI
 SPI_DEV(0) MOSI is used (fixed)
 
#define SDCARD_SPI_PARAM_MISO   SPI0_MISO
 SPI_DEV(0) MISO is used (fixed)
 
#define SDCARD_SPI_PARAM_POWER   GPIO_UNDEF
 power control is not used (fixed)
 
#define SDCARD_SPI_PARAM_CS   SPI0_CS0
 SD-Card CS signal (can be overridden)