rotaryr.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 ROTARYR_H
#define ROTARYR_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"
 
#define ROTARYR_ONE_LED      0x0001
#define ROTARYR_TWO_LED      0x0101
#define ROTARYR_FOUR_LED     0x1111
#define ROTARYR_EIGHT_LED    0x5555
#define ROTARYR_RESET_LED    0x0000
 
 // rotaryr_led
 
#define ROTARYR_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.ecb = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.eca = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.sw = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // rotaryr_map
 // rotaryr
 
typedef struct
{
    // Output pins
 
    digital_out_t  rst; 
    digital_out_t cs;
 
    // Input pins
 
    digital_in_t   ecb;  
    digital_in_t   eca;  
    digital_in_t   sw;   
 
    // Modules
 
    spi_master_t  spi;                               
    pin_name_t  chip_select;                         
} rotaryr_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  ecb;      
    pin_name_t  rst;      
    pin_name_t  eca;      
    pin_name_t  sw;       
 
    // static variable
 
    uint32_t                           spi_speed;        
    spi_master_mode_t                  spi_mode;         
    spi_master_chip_select_polarity_t  cs_polarity;      
} rotaryr_cfg_t;
 
typedef enum
{
   ROTARYR_OK = 0,
   ROTARYR_ERROR = -1
 
} rotaryr_return_value_t;
 
void rotaryr_cfg_setup ( rotaryr_cfg_t *cfg );
 
err_t rotaryr_init ( rotaryr_t *ctx, rotaryr_cfg_t *cfg );
 
void rotaryr_generic_transfer ( rotaryr_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len );
 
void rotaryr_turn_on_led_by_data ( rotaryr_t *ctx, uint16_t write_data );
 
void rotaryr_turn_on_led_by_position ( rotaryr_t *ctx, uint8_t led_position );
 
uint8_t rotaryr_button_push ( rotaryr_t *ctx );
 
uint16_t rotaryr_get_led_data ( uint8_t current_led_state );
 
void rotaryr_reset_led ( rotaryr_t *ctx );
 
uint8_t rotaryr_get_ecb_state ( rotaryr_t *ctx );
 
uint8_t rotaryr_get_eca_state ( rotaryr_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // ROTARYR_H
 
 // rotaryr
 
// ------------------------------------------------------------------------ END