rotaryo2.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef ROTARYO2_H
#define ROTARYO2_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"
 
#define ROTARYO2_SET_LED_OFF               0x0000u
#define ROTARYO2_SET_LED_DATA_1            0x0001u
#define ROTARYO2_SET_LED_DATA_2            0x0002u
#define ROTARYO2_SET_LED_DATA_3            0x0004u
#define ROTARYO2_SET_LED_DATA_4            0x0008u
#define ROTARYO2_SET_LED_DATA_5            0x0010u
#define ROTARYO2_SET_LED_DATA_6            0x0020u
#define ROTARYO2_SET_LED_DATA_7            0x0040u
#define ROTARYO2_SET_LED_DATA_8            0x0080u
#define ROTARYO2_SET_LED_DATA_9            0x0100u
#define ROTARYO2_SET_LED_DATA_10           0x0200u
#define ROTARYO2_SET_LED_DATA_11           0x0400u
#define ROTARYO2_SET_LED_DATA_12           0x0800u
#define ROTARYO2_SET_LED_DATA_13           0x1000u
#define ROTARYO2_SET_LED_DATA_14           0x2000u
#define ROTARYO2_SET_LED_DATA_15           0x4000u
#define ROTARYO2_SET_LED_DATA_16           0x8000u
 
#define ROTARYO2_SET_LED_POS_1             1 
#define ROTARYO2_SET_LED_POS_2             2 
#define ROTARYO2_SET_LED_POS_3             3 
#define ROTARYO2_SET_LED_POS_4             4 
#define ROTARYO2_SET_LED_POS_5             5 
#define ROTARYO2_SET_LED_POS_6             6 
#define ROTARYO2_SET_LED_POS_7             7 
#define ROTARYO2_SET_LED_POS_8             8 
#define ROTARYO2_SET_LED_POS_9             9 
#define ROTARYO2_SET_LED_POS_10            10
#define ROTARYO2_SET_LED_POS_11            11
#define ROTARYO2_SET_LED_POS_12            12
#define ROTARYO2_SET_LED_POS_13            13
#define ROTARYO2_SET_LED_POS_14            14
#define ROTARYO2_SET_LED_POS_15            15
#define ROTARYO2_SET_LED_POS_16            16
 
#define ROTARYO2_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define ROTARYO2_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // rotaryo2_set
 
#define ROTARYO2_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK );  \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS );   \
    cfg.enb  = MIKROBUS( mikrobus, MIKROBUS_AN );   \
    cfg.ena  = MIKROBUS( mikrobus, MIKROBUS_PWM );  \
    cfg.sw   = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // rotaryo2_map
 // rotaryo2
 
typedef struct
{
   // Input pins
    digital_in_t enb;            
    digital_in_t ena;            
    digital_in_t sw;             
    // Modules
    spi_master_t spi;            
    pin_name_t   chip_select;    
} rotaryo2_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t miso;            
    pin_name_t mosi;            
    pin_name_t sck;             
    pin_name_t cs;              
    // Additional gpio pins
    pin_name_t enb;             
    pin_name_t ena;             
    pin_name_t sw;              
    // static variable
    uint32_t                          spi_speed;    
    spi_master_mode_t                 spi_mode;     
    spi_master_chip_select_polarity_t cs_polarity;  
} rotaryo2_cfg_t;
 
typedef enum
{
    ROTARYO2_OK = 0,
    ROTARYO2_ERROR = -1
 
} rotaryo2_return_value_t;
 
void rotaryo2_cfg_setup ( rotaryo2_cfg_t *cfg );
 
err_t rotaryo2_init ( rotaryo2_t *ctx, rotaryo2_cfg_t *cfg );
 
err_t rotaryo2_default_cfg ( rotaryo2_t *ctx );
 
err_t rotaryo2_set_led_data ( rotaryo2_t *ctx, uint16_t data_in );
 
err_t rotaryo2_get_led_data ( rotaryo2_t *ctx, uint16_t *data_out );
 
err_t rotaryo2_set_led_pos ( rotaryo2_t *ctx, uint8_t led_pos );
 
uint8_t rotaryo2_get_state_switch ( rotaryo2_t *ctx );
 
uint8_t rotaryo2_get_state_ena ( rotaryo2_t *ctx );
 
uint8_t rotaryo2_get_state_enb ( rotaryo2_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // ROTARYO2_H
 
 // rotaryo2
 
// ------------------------------------------------------------------------ END