periph_cpu.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2015 Freie Universität Berlin
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once
 
#include "periph_conf.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#if !defined(CPUID_LEN) || defined(DOXYGEN)
#  define CPUID_LEN           (4U)
#endif
 
#if !defined(PM_NUM_MODES) || defined(DOXYGEN)
#  define PM_NUM_MODES        (1U)
#endif
 
#define PROVIDES_PM_LAYERED_OFF
 
/* GPIO configuration only if the module is available (=Linux) */
#if defined(MODULE_PERIPH_GPIO_LINUX) || defined(DOXYGEN)
#  include <linux/gpio.h>
 
/* MARK: - GPIO Configuration */
#  define GPIO_PORT_SHIFT     (24)
 
#  define GPIO_PIN(port, pin) (gpio_t)((port << GPIO_PORT_SHIFT) | pin)
 
#  define HAVE_GPIO_MODE_T
#  if !defined(GPIOHANDLE_REQUEST_PULL_DOWN) || defined(DOXYGEN)
#    if defined(GPIOHANDLE_REQUEST_BIAS_PULL_DOWN)
#      define GPIOHANDLE_REQUEST_PULL_DOWN    GPIOHANDLE_REQUEST_BIAS_PULL_DOWN
#    else
#      define GPIOHANDLE_REQUEST_PULL_DOWN    (0xFF)
#    endif
#  endif
#  if !defined(GPIOHANDLE_REQUEST_PULL_UP) || defined(DOXYGEN)
#    if defined(GPIOHANDLE_REQUEST_BIAS_PULL_UP)
#      define GPIOHANDLE_REQUEST_PULL_UP      GPIOHANDLE_REQUEST_BIAS_PULL_UP
#    else
#      define GPIOHANDLE_REQUEST_PULL_UP      (0xFF)
#    endif
#  endif
 
typedef enum {
    GPIO_IN    = GPIOHANDLE_REQUEST_INPUT,
    GPIO_IN_PD = GPIOHANDLE_REQUEST_INPUT | GPIOHANDLE_REQUEST_PULL_DOWN,
    GPIO_IN_PU = GPIOHANDLE_REQUEST_INPUT | GPIOHANDLE_REQUEST_PULL_UP,
    GPIO_OUT   = GPIOHANDLE_REQUEST_OUTPUT,
    GPIO_OD    = GPIOHANDLE_REQUEST_OPEN_DRAIN,
    GPIO_OD_PU = GPIOHANDLE_REQUEST_OPEN_DRAIN | GPIOHANDLE_REQUEST_PULL_UP
} gpio_mode_t;
 
#  define HAVE_GPIO_FLANK_T
 
typedef enum {
    GPIO_FALLING = GPIOEVENT_EVENT_FALLING_EDGE,    
    GPIO_RISING = GPIOEVENT_EVENT_RISING_EDGE,      
    GPIO_BOTH = GPIO_FALLING | GPIO_RISING          
} gpio_flank_t;
#elif defined(MODULE_PERIPH_GPIO_MOCK)
 
typedef struct {
    int value;              
    int mode;               
    int flank;              
    void (*cb)(void *arg);  
    void *arg;              
} gpio_mock_t;
 
#  define GPIO_UNDEF          0
 
#  if !defined(GPIO_PORT_MAX) || defined(DOXYGEN)
#    define GPIO_PORT_MAX       (16)
#  endif
 
#  if !defined(GPIO_PIN_MAX) || defined(DOXYGEN)
#    define GPIO_PIN_MAX        (32)
#  endif
 
extern gpio_mock_t gpio_mock[GPIO_PORT_MAX][GPIO_PIN_MAX];
 
#  define HAVE_GPIO_T
typedef gpio_mock_t* gpio_t;
 
#  define GPIO_PIN(port, pin) \
    (((port >= 0) && (pin >= 0) && (port < GPIO_PORT_MAX) && (pin < GPIO_PIN_MAX)) \
     ? &gpio_mock[port][pin] \
     : GPIO_UNDEF)
 
#endif /* MODULE_PERIPH_GPIO_LINUX | DOXYGEN */
 
#define PERIPH_TIMER_PROVIDES_SET
 
/* MARK: - Power management configuration*/
#define PROVIDES_PM_OFF
#define PROVIDES_PM_SET_LOWEST
#define PERIPH_I2C_NEED_READ_REG
#define PERIPH_I2C_NEED_READ_REGS
#define PERIPH_I2C_NEED_WRITE_REG
#define PERIPH_I2C_NEED_WRITE_REGS
 
#if defined(MODULE_PERIPH_I2C_MOCK) || defined(DOXYGEN)
typedef struct {
    void *dummy;    
} i2c_conf_t;
#endif
 
/* Configuration for the wrapper around the Linux SPI API (periph_spidev_linux)
 *
 * Needs to go here, otherwise the SPI_NEEDS_ are defined after inclusion of
 * spi.h.
 */
#if defined(MODULE_PERIPH_SPIDEV_LINUX) || defined(DOXYGEN)
/* MARK: - SPI Configuration */
#  define PERIPH_SPI_NEEDS_TRANSFER_BYTE
#  define PERIPH_SPI_NEEDS_TRANSFER_REG
#  define PERIPH_SPI_NEEDS_TRANSFER_REGS
 
#  ifndef DOXYGEN
#    define HAVE_SPI_CLK_T
typedef enum {
    SPI_CLK_100KHZ = (100000U),
    SPI_CLK_400KHZ = (400000U),
    SPI_CLK_1MHZ   = (1000000U),
    SPI_CLK_5MHZ   = (5000000U),
    SPI_CLK_10MHZ  = (10000000U)
} spi_clk_t;
#  endif /* ndef DOXYGEN */
#endif /* MODULE_PERIPH_SPI | DOXYGEN */
 
#if !defined(EEPROM_SIZE) || defined(DOXYGEN)
#  define EEPROM_SIZE             (1024U)  /* 1kB */
#endif
 
#ifdef MODULE_PERIPH_CAN
#  include "candev_linux.h"
#endif
 
#ifdef __cplusplus
}
#endif