dfplayer_types.h

Go to the documentation of this file.

/*
 * Copyright 2019 Marian Buschsieweke
 *
 * 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 DFPLAYER_TYPES_H
#define DFPLAYER_TYPES_H
 
#include <stdbool.h>
#include <stdint.h>
 
#include "kernel_types.h"
#include "mutex.h"
#include "periph/gpio.h"
#include "periph/uart.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum {
    DFPLAYER_RX_STATE_START,    
    DFPLAYER_RX_STATE_VERSION,  
    DFPLAYER_RX_STATE_LENGTH,   
    DFPLAYER_RX_STATE_DATA,     
    DFPLAYER_RX_STATE_NUMOF     
} dfplayer_rx_state_t;
 
typedef enum {
    DFPLAYER_EQ_NORMAL,         
    DFPLAYER_EQ_POP,            
    DFPLAYER_EQ_ROCK,           
    DFPLAYER_EQ_JAZZ,           
    DFPLAYER_EQ_CLASSIC,        
    DFPLAYER_EQ_BASE,           
    DFPLAYER_EQ_NUMOF           
} dfplayer_eq_t;
 
typedef enum {
    DFPLAYER_MODE_UNKOWN,       
    DFPLAYER_MODE_REPEAT_DIR,   
    DFPLAYER_MODE_REPEAT,       
    DFPLAYER_MODE_RANDOM,       
    DFPLAYER_MODE_NORMAL,       
    DFPLAYER_MODE_NUMOF         
} dfplayer_mode_t;
 
typedef enum {
    DFPLAYER_SOURCE_USB,        
    DFPLAYER_SOURCE_SDCARD,     
    DFPLAYER_SOURCE_AUX,        
    DFPLAYER_SOURCE_SLEEP,      
    DFPLAYER_SOURCE_FLASH,      
    DFPLAYER_SOURCE_NUMOF       
} dfplayer_source_t;
 
typedef enum {
    DFPLAYER_STATE_PLAYING,     
    DFPLAYER_STATE_PAUSED,      
    DFPLAYER_STATE_STOPPED,     
    DFPLAYER_STATE_NUMOF,       
} dfplayer_state_t;
 
typedef enum {
    DFPLAYER_SCHEME_FOLDER_FILE,
    DFPLAYER_SCHEME_MP3_FILE,   
    DFPLAYER_SCHEME_NUMOF,      
} dfplayer_scheme_t;
 
typedef uint8_t dfplayer_source_set_t;
 
typedef struct dfplayer dfplayer_t;
 
typedef void (*dfplayer_cb_done_t)(dfplayer_t *dev, dfplayer_source_t src,
                                   uint16_t track);
 
typedef void (*dfplayer_cb_src_t)(dfplayer_t *dev, dfplayer_source_set_t srcs);
 
typedef struct {
    uart_t uart;                
    gpio_t busy_pin;            
    uint8_t volume;             
} dfplayer_params_t;
 
typedef struct {
    union {
        uint16_t number;        
        struct {
            uint8_t folder;     
            uint8_t file;       
        };
    };
    dfplayer_scheme_t scheme;   
} dfplayer_file_t;
 
struct dfplayer {
    dfplayer_cb_done_t cb_done; 
    dfplayer_cb_src_t cb_src;   
    uint32_t last_event_us;     
    uint8_t buf[6];             
    dfplayer_file_t file;       
    uint8_t len;                
    uint8_t flags;              
    mutex_t mutex;              
    uart_t uart;                
    gpio_t busy_pin;            
    mutex_t sync;               
    dfplayer_source_set_t srcs; 
    dfplayer_rx_state_t state;  
};
 
#ifdef __cplusplus
}
#endif
 
#endif /* DFPLAYER_TYPES_H */