CPU specific definitions and functions for peripheral handling. More...

Detailed Description

CPU specific definitions and functions for peripheral handling.

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

Definition in file periph_cpu.h.

#include <stdint.h>
#include <limits.h>
#include "eagle_soc.h"
#include "cpu_conf.h"
#include "macros/units.h"

Include dependency graph for periph_cpu.h:

Go to the source code of this file.

Data Structures
struct	i2c_conf_t
	I2C configuration structure. More...

struct	spi_conf_t
	SPI device configuration. More...

struct	uart_conf_t
	UART device configuration. More...

Macros
#define	GPIO_UNDEF ((gpio_t)(UINT_MAX))
	Definition of a fitting UNDEF value.

#define	GPIO_PIN(x, y) ((x & 0) \| y)
	Define a CPU specific GPIO pin generator macro.

#define	PORT_GPIO (0)
	Available GPIO ports on ESP8266.

#define	GPIO_PIN_NUMOF (17)
	Define CPU specific number of GPIO pins.

#define	PERIPH_TIMER_PROVIDES_SET
	Prevent shared timer functions from being used.

#define	CPUID_LEN (4U)
	Length of the CPU_ID in octets.

#define	CPU_CYCLES_PER_LOOP (5)
	CPU cycles per busy wait loop.

GPIO configuration
#define	HAVE_GPIO_T
	Override the default gpio_t type definition.

typedef unsigned int	gpio_t

Predefined GPIO names
#define	GPIO0 (GPIO_PIN(PORT_GPIO, 0))

#define	GPIO1 (GPIO_PIN(PORT_GPIO, 1))

#define	GPIO2 (GPIO_PIN(PORT_GPIO, 2))

#define	GPIO3 (GPIO_PIN(PORT_GPIO, 3))

#define	GPIO4 (GPIO_PIN(PORT_GPIO, 4))

#define	GPIO5 (GPIO_PIN(PORT_GPIO, 5))

#define	GPIO6 (GPIO_PIN(PORT_GPIO, 6))

#define	GPIO7 (GPIO_PIN(PORT_GPIO, 7))

#define	GPIO8 (GPIO_PIN(PORT_GPIO, 8))

#define	GPIO9 (GPIO_PIN(PORT_GPIO, 9))

#define	GPIO10 (GPIO_PIN(PORT_GPIO, 10))

#define	GPIO11 (GPIO_PIN(PORT_GPIO, 11))

#define	GPIO12 (GPIO_PIN(PORT_GPIO, 12))

#define	GPIO13 (GPIO_PIN(PORT_GPIO, 13))

#define	GPIO14 (GPIO_PIN(PORT_GPIO, 14))

#define	GPIO15 (GPIO_PIN(PORT_GPIO, 15))

#define	GPIO16 (GPIO_PIN(PORT_GPIO, 16))

I2C configuration
ESP8266 provides up to two bit-banging I2C interfaces. The board-specific configuration of the I2C interface I2C_DEV(n) requires the definition of I2Cn_SPEED, the bus speed, I2Cn_SCL, the GPIO used as SCL signal, and I2Cn_SDA, the GPIO used as SDA signal, where n can be 0 or 1. If they are not defined, the I2C interface I2C_DEV(n) is not used. Note The configuration of the I2C interfaces I2C_DEV(n) must be in continuous ascending order of n. I2C_NUMOF is determined automatically from board-specific peripheral definitions of I2Cn_SPEED, I2Cn_SCK, and I2Cn_SDA.
#define	I2C_NUMOF_MAX (2)
	Maximum number of I2C interfaces that can be used by board definitions.

#define	PERIPH_I2C_NEED_READ_REG
	i2c_read_reg required

#define	PERIPH_I2C_NEED_READ_REGS
	i2c_read_regs required

#define	PERIPH_I2C_NEED_WRITE_REG
	i2c_write_reg required

#define	PERIPH_I2C_NEED_WRITE_REGS
	i2c_write_regs required

PWM configuration
The hardware implementation of ESP8266 PWM supports only frequencies as power of two. Therefore a software implementation of one PWM device PWM_DEV(0) with up to 8 PWM channels (PWM_CHANNEL_NUM_MAX) is used. The GPIOs that can be used as PWM channels are defined by PWM0_GPIOS in board definition. Note The minimum PWM period that can be realized is 10 us or 100.000 PWM clock cycles per second. Therefore, the product of frequency and resolution should not be greater than 100.000. Otherwise the frequency is scaled down automatically.
#define	PWM_NUMOF_MAX (1)
	Maximum number of PWM devices.

#define	PWM_CHANNEL_NUM_MAX (8)
	Maximum number of channels per PWM device.

RNG configuration
#define	RNG_DATA_REG_ADDR (0x3ff20e44)
	The address of the register for accessing the hardware RNG.

RTT and RTC configuration
#define	RTT_FREQUENCY (312500UL)

#define	RTT_MAX_VALUE (0xFFFFFFFFUL)

SPI configuration

ESP8266 has two SPI controllers:

CSPI for caching and accessing the flash memory
HSPI for peripherals

Thus, HSPI is the only SPI interface that is available for peripherals. It is exposed as RIOT's SPI_DEV(0). The pin configuration of the HSPI interface is fixed as shown in following table.

Signal	Pin
SPI0_MISO	GPIO12
SPI0_MOSI	GPIO13
SPI0_SCK	GPIO14
SPI0_CS0	GPIOn with n = 0, 2, 4, 5, 15, 16 (additionally 9, 10 in DOUT flash mode)

The only pin definition that can be overridden by an application-specific board configuration is the CS signal defined by SPI0_CS0.

#define HAVE_SPI_CLK_T

Override SPI clock speed values.

#define SPI_NUMOF_MAX (1)

Maximum number of SPI interfaces.

#define PERIPH_SPI_NEEDS_TRANSFER_BYTE

requires function spi_transfer_byte

#define PERIPH_SPI_NEEDS_TRANSFER_REG

requires function spi_transfer_reg

#define PERIPH_SPI_NEEDS_TRANSFER_REGS

requires function spi_transfer_regs

enum spi_ctrl_t { HSPI = 1 }

SPI controllers that can be used for peripheral interfaces. More...

enum spi_clk_t {
SPI_CLK_100KHZ = KHZ(100) , SPI_CLK_400KHZ = KHZ(400) , SPI_CLK_1MHZ = MHZ(1) , SPI_CLK_5MHZ = MHZ(5) ,
SPI_CLK_10MHZ = MHZ(10)
}

UART configuration
All ESP8266 boards have exactly one UART device with fixed pin mapping.
#define	UART_NUMOF_MAX (2)
	Maximum number of UART interfaces.

Macro Definition Documentation

◆ CPU_CYCLES_PER_LOOP

#define CPU_CYCLES_PER_LOOP (5)

CPU cycles per busy wait loop.

Definition at line 41 of file periph_cpu.h.

◆ CPUID_LEN

#define CPUID_LEN (4U)

Length of the CPU_ID in octets.

Definition at line 36 of file periph_cpu.h.

◆ GPIO0

#define GPIO0 (GPIO_PIN(PORT_GPIO, 0))

Definition at line 99 of file periph_cpu.h.

◆ GPIO1

#define GPIO1 (GPIO_PIN(PORT_GPIO, 1))

Definition at line 100 of file periph_cpu.h.

◆ GPIO10

#define GPIO10 (GPIO_PIN(PORT_GPIO, 10))

Definition at line 109 of file periph_cpu.h.

◆ GPIO11

#define GPIO11 (GPIO_PIN(PORT_GPIO, 11))

Definition at line 110 of file periph_cpu.h.

◆ GPIO12

#define GPIO12 (GPIO_PIN(PORT_GPIO, 12))

Definition at line 111 of file periph_cpu.h.

◆ GPIO13

#define GPIO13 (GPIO_PIN(PORT_GPIO, 13))

Definition at line 112 of file periph_cpu.h.

◆ GPIO14

#define GPIO14 (GPIO_PIN(PORT_GPIO, 14))

Definition at line 113 of file periph_cpu.h.

◆ GPIO15

#define GPIO15 (GPIO_PIN(PORT_GPIO, 15))

Definition at line 114 of file periph_cpu.h.

◆ GPIO16

#define GPIO16 (GPIO_PIN(PORT_GPIO, 16))

Definition at line 115 of file periph_cpu.h.

◆ GPIO2

#define GPIO2 (GPIO_PIN(PORT_GPIO, 2))

Definition at line 101 of file periph_cpu.h.

◆ GPIO3

#define GPIO3 (GPIO_PIN(PORT_GPIO, 3))

Definition at line 102 of file periph_cpu.h.

◆ GPIO4

#define GPIO4 (GPIO_PIN(PORT_GPIO, 4))

Definition at line 103 of file periph_cpu.h.

◆ GPIO5

#define GPIO5 (GPIO_PIN(PORT_GPIO, 5))

Definition at line 104 of file periph_cpu.h.

◆ GPIO6

#define GPIO6 (GPIO_PIN(PORT_GPIO, 6))

Definition at line 105 of file periph_cpu.h.

◆ GPIO7

#define GPIO7 (GPIO_PIN(PORT_GPIO, 7))

Definition at line 106 of file periph_cpu.h.

◆ GPIO8

#define GPIO8 (GPIO_PIN(PORT_GPIO, 8))

Definition at line 107 of file periph_cpu.h.

◆ GPIO9

#define GPIO9 (GPIO_PIN(PORT_GPIO, 9))

Definition at line 108 of file periph_cpu.h.

◆ GPIO_PIN

#define GPIO_PIN	(	x,
		y
	)	((x & 0) \| y)

Define a CPU specific GPIO pin generator macro.

Definition at line 66 of file periph_cpu.h.

◆ GPIO_PIN_NUMOF

#define GPIO_PIN_NUMOF (17)

Define CPU specific number of GPIO pins.

Definition at line 76 of file periph_cpu.h.

◆ GPIO_UNDEF

#define GPIO_UNDEF ((gpio_t)(UINT_MAX))

Definition of a fitting UNDEF value.

Definition at line 61 of file periph_cpu.h.

◆ HAVE_GPIO_T

#define HAVE_GPIO_T

Override the default gpio_t type definition.

This is required here to have gpio_t defined in this file.

Definition at line 54 of file periph_cpu.h.

◆ HAVE_SPI_CLK_T

#define HAVE_SPI_CLK_T

Override SPI clock speed values.

Definition at line 273 of file periph_cpu.h.

◆ I2C_NUMOF_MAX

#define I2C_NUMOF_MAX (2)

Maximum number of I2C interfaces that can be used by board definitions.

Definition at line 172 of file periph_cpu.h.

◆ PERIPH_I2C_NEED_READ_REG

#define PERIPH_I2C_NEED_READ_REG

i2c_read_reg required

Definition at line 174 of file periph_cpu.h.

◆ PERIPH_I2C_NEED_READ_REGS

#define PERIPH_I2C_NEED_READ_REGS

i2c_read_regs required

Definition at line 175 of file periph_cpu.h.

◆ PERIPH_I2C_NEED_WRITE_REG

#define PERIPH_I2C_NEED_WRITE_REG

i2c_write_reg required

Definition at line 176 of file periph_cpu.h.

◆ PERIPH_I2C_NEED_WRITE_REGS

#define PERIPH_I2C_NEED_WRITE_REGS

i2c_write_regs required

Definition at line 177 of file periph_cpu.h.

◆ PERIPH_SPI_NEEDS_TRANSFER_BYTE

#define PERIPH_SPI_NEEDS_TRANSFER_BYTE

requires function spi_transfer_byte

Definition at line 298 of file periph_cpu.h.

◆ PERIPH_SPI_NEEDS_TRANSFER_REG

#define PERIPH_SPI_NEEDS_TRANSFER_REG

requires function spi_transfer_reg

Definition at line 299 of file periph_cpu.h.

◆ PERIPH_SPI_NEEDS_TRANSFER_REGS

#define PERIPH_SPI_NEEDS_TRANSFER_REGS

requires function spi_transfer_regs

Definition at line 300 of file periph_cpu.h.

◆ PERIPH_TIMER_PROVIDES_SET

#define PERIPH_TIMER_PROVIDES_SET

Prevent shared timer functions from being used.

Definition at line 308 of file periph_cpu.h.

◆ PORT_GPIO

#define PORT_GPIO (0)

Available GPIO ports on ESP8266.

Definition at line 71 of file periph_cpu.h.

◆ PROVIDES_PM_OFF

#define PROVIDES_PM_OFF

Definition at line 186 of file periph_cpu.h.

◆ PROVIDES_PM_RESTART

#define PROVIDES_PM_RESTART

Definition at line 185 of file periph_cpu.h.

◆ PROVIDES_PM_SET_LOWEST

#define PROVIDES_PM_SET_LOWEST

Definition at line 184 of file periph_cpu.h.

◆ PWM_CHANNEL_NUM_MAX

#define PWM_CHANNEL_NUM_MAX (8)

Maximum number of channels per PWM device.

Definition at line 214 of file periph_cpu.h.

◆ PWM_NUMOF_MAX

#define PWM_NUMOF_MAX (1)

Maximum number of PWM devices.

Definition at line 209 of file periph_cpu.h.

◆ RNG_DATA_REG_ADDR

#define RNG_DATA_REG_ADDR (0x3ff20e44)

The address of the register for accessing the hardware RNG.

Definition at line 226 of file periph_cpu.h.

◆ RTT_FREQUENCY

#define RTT_FREQUENCY (312500UL)

Definition at line 233 of file periph_cpu.h.

◆ RTT_MAX_VALUE

#define RTT_MAX_VALUE (0xFFFFFFFFUL)

Definition at line 234 of file periph_cpu.h.

◆ SPI_NUMOF_MAX

#define SPI_NUMOF_MAX (1)

Maximum number of SPI interfaces.

Definition at line 296 of file periph_cpu.h.

◆ UART_NUMOF_MAX

#define UART_NUMOF_MAX (2)

Maximum number of UART interfaces.

Definition at line 329 of file periph_cpu.h.

Typedef Documentation

◆ gpio_t

typedef unsigned int gpio_t

Definition at line 55 of file periph_cpu.h.

Enumeration Type Documentation

◆ spi_clk_t

enum spi_clk_t

Enumerator
SPI_CLK_100KHZ	drive the SPI bus with 100KHz
SPI_CLK_400KHZ	drive the SPI bus with 400KHz
SPI_CLK_1MHZ	drive the SPI bus with 1MHz
SPI_CLK_5MHZ	drive the SPI bus with 5MHz
SPI_CLK_10MHZ	drive the SPI bus with 10MHz

Definition at line 274 of file periph_cpu.h.

◆ spi_ctrl_t

enum spi_ctrl_t

SPI controllers that can be used for peripheral interfaces.

Enumerator
HSPI	HSPI interface controller.

Definition at line 265 of file periph_cpu.h.