joystick.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 JOYSTCIK_H
#define JOYSTCIK_H
 
#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_i2c_master.h"
 
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define JOYSTICK_I2C_ADDRESS_0                                     0x40
#define JOYSTICK_I2C_ADDRESS_1                                     0x41
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define JOYSTICK_ID_CODE                                           0x0C
#define JOYSTICK_ID_VERSION                                        0x0D
#define JOYSTICK_SIL_REV                                           0x0E
#define JOYSTICK_CONTROL1                                          0x0F
#define JOYSTICK_CONTROL2                                          0x2E
#define JOYSTICK_X                                                 0x10
#define JOYSTICK_Y_RES_INT                                         0x11
#define JOYSTICK_XP                                                0x12
#define JOYSTICK_XN                                                0x13
#define JOYSTICK_YP                                                0x14
#define JOYSTICK_YN                                                0x15
#define JOYSTICK_AGC                                               0x2A
#define JOYSTICK_M_CTRL                                            0x2B
#define JOYSTICK_J_CTRL                                            0x2C
#define JOYSTICK_T_CTRL                                            0x2D
#define JOYSTICK_CONTROL2_TEST_CMD                                 0x84
#define JOYSTICK_AGC_MAX_SENSITIVITY_CMD                           0x3F
#define JOYSTICK_T_CTRL_SCALING_90_8_CMD                           0x0A
#define JOYSTICK_T_CTRL_SCALING_100_CMD                            0x09
#define JOYSTICK_CONTROL1_RESET_CMD                                0x88
#define JOYSTICK_INVERT_SPINING_CMD                                0x86
#define JOYSTCIK_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA );\
  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );\
  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST );\
  cfg.tst = MIKROBUS( mikrobus, MIKROBUS_CS );
  
#define JOYSTCIK_RETVAL  uint8_t
#define JOYSTCIK_OK           0x00
#define JOYSTCIK_INIT_ERROR   0xFF
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t rst;
    
 
    // Input pins 
 
    digital_in_t int_pin;
    digital_in_t tst;
 
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} joystick_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t rst;
    pin_name_t tst;
    pin_name_t int_pin;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} joystick_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void joystick_cfg_setup ( joystick_cfg_t *cfg );
 
JOYSTCIK_RETVAL joystick_init ( joystick_t *ctx, joystick_cfg_t *cfg );
 
void joystick_default_cfg ( joystick_t *ctx );
 
void joystick_generic_write ( joystick_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void joystick_generic_read ( joystick_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void joystick_set_default_configuration ( joystick_t *ctx );
 
uint8_t joystick_check_id_code ( joystick_t *ctx );
 
uint8_t joystick_check_id_version ( joystick_t *ctx );
 
void joystick_set_low_power_mode ( joystick_t *ctx, uint8_t timings );
 
void joystick_set_scaling_factor ( joystick_t *ctx, uint8_t scaling_factor );
 
void joystick_disabled_interrupt( joystick_t *ctx );
 
void joystick_enabled_interrupt( joystick_t *ctx );
 
void joystick_invert_spinning( joystick_t *ctx );
 
uint8_t joystick_get_position( joystick_t *ctx );
 
uint8_t joystick_get_interrupt ( joystick_t *ctx );
 
uint8_t joystick_press_button( joystick_t *ctx );
 
void joystick_soft_reset( joystick_t *ctx );
 
void joystick_hardware_reset( joystick_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _JOYSTCIK_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END