periph.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2015 Freie Universität Berlin
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#if MODULE_SAUL_GPIO || DOXYGEN
#include "periph/gpio.h"
#endif /* MODULE_SAUL_GPIO */
 
#if MODULE_SAUL_ADC || DOXYGEN
#include "periph/adc.h"
#endif /* MODULE_SAUL_ADC */
 
#if MODULE_SAUL_PWM || DOXYGEN
#include "periph/pwm.h"
#endif /* MODULE_SAUL_PWM */
 
#ifdef __cplusplus
extern "C" {
#endif
 
#if MODULE_SAUL_GPIO || DOXYGEN
typedef enum {
    SAUL_GPIO_INVERTED   = (1 << 0),  
    SAUL_GPIO_INIT_CLEAR = (1 << 1),  
    SAUL_GPIO_INIT_SET   = (1 << 2),  
} saul_gpio_flags_t;

typedef struct {
    const char *name;           
    gpio_t pin;                 
    gpio_mode_t mode;           
    saul_gpio_flags_t flags;    
} saul_gpio_params_t;
#endif /* MODULE_SAUL_GPIO */
 
#if MODULE_SAUL_ADC || DOXYGEN
typedef struct {
    const char *name;       
    adc_t line;             
    adc_res_t res;          
} saul_adc_params_t;
#endif /* MODULE_SAUL_ADC */
 
#if MODULE_SAUL_PWM || DOXYGEN
static const uint16_t saul_pwm_resolution = 255;

typedef enum {
    SAUL_PWM_REGULAR  = (0 << 0),  
    SAUL_PWM_INVERTED = (1 << 0),  
} saul_pwm_flags_t;

typedef struct {
    pwm_t dev;                  
    uint8_t channel;            
    saul_pwm_flags_t flags;     
} saul_pwm_channel_t;

#define SAUL_PWM_FREQ_DEFAULT 1000

/* This is not applied here as it would later need to be undef'd; actual
 * application of the default happens in auto_init_saul_pwm.c */
#if DOXYGEN
#define SAUL_PWM_FREQ SAUL_PWM_FREQ_DEFAULT
#endif

#if DOXYGEN
#define SAUL_PWM_NO_DIMMER
#endif

typedef struct {
    const char *name;           
    saul_pwm_channel_t channel; 
} saul_pwm_dimmer_params_t;

#if DOXYGEN
#define SAUL_PWM_NO_RGB
#endif

typedef struct {
    const char *name;               
    saul_pwm_channel_t channels[3]; 
} saul_pwm_rgb_params_t;
 
#endif /* MODULE_SAUL_PWM */
 
#ifdef __cplusplus
}
#endif