qdec.h

Go to the documentation of this file.

/*
 * Copyright (C) 2017 Gilles DOFFE <gdoffe@gmail.com>
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#ifndef PERIPH_QDEC_H
#define PERIPH_QDEC_H
 
#include <stdint.h>
#include <limits.h>
 
#include "periph_cpu.h"
#include "periph_conf.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef QDEC_DEV
#define QDEC_DEV(x)          (x)
#endif
 
#ifndef QDEC_UNDEF
#define QDEC_UNDEF           (UINT_FAST8_MAX)
#endif
 
#ifndef HAVE_QDEC_T
typedef uint_fast8_t qdec_t;
#endif
 
#ifndef HAVE_QDEC_MODE_T
typedef enum {
    QDEC_X1,    /* X1 mode */
    QDEC_X2,    /* X2 mode */
    QDEC_X4,    /* X4 mode */
} qdec_mode_t;
#endif
 
typedef void (*qdec_cb_t)(void *arg);
 
#ifndef HAVE_TIMER_ISR_CTX_T
typedef struct {
    qdec_cb_t cb;           
    void *arg;              
} qdec_isr_ctx_t;
#endif
 
int32_t qdec_init(qdec_t dev, qdec_mode_t mode, qdec_cb_t cb, void *arg);
 
int32_t qdec_read(qdec_t dev);
 
int32_t qdec_read_and_reset(qdec_t dev);
 
void qdec_start(qdec_t qdec);
 
void qdec_stop(qdec_t qdec);
 
#ifdef __cplusplus
}
#endif
 
#endif /* PERIPH_QDEC_H */