hallcurrent.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 HALLCURRENT_H
#define HALLCURRENT_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_spi_master.h"
#include "spi_specifics.h"
 
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define HALLCURRENT_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.ocd   = MIKROBUS( mikrobus, MIKROBUS_INT );
#define HALLCURRENT_OK                      0
#define HALLCURRENT_ERROR                  -1
#define HALLCURRENT_SET_DATA_SAMPLE_EDGE    SET_SPI_DATA_SAMPLE_EDGE
#define HALLCURRENT_SET_DATA_SAMPLE_MIDDLE  SET_SPI_DATA_SAMPLE_MIDDLE
 
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    digital_in_t ocd;
    
    // Modules 
    spi_master_t spi;
    pin_name_t chip_select;
 
} hallcurrent_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 ocd;
 
    // static variable 
    uint32_t spi_speed;
    spi_master_mode_t spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
 
} hallcurrent_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void hallcurrent_cfg_setup ( hallcurrent_cfg_t *cfg );
 
err_t hallcurrent_init ( hallcurrent_t *ctx, hallcurrent_cfg_t *cfg );
 
uint16_t hallcurrent_read_data ( hallcurrent_t *ctx );
 
uint8_t hallcurrent_check_status ( hallcurrent_t *ctx );
 
float hallcurrent_read_current ( hallcurrent_t *ctx );
 
uint8_t hallcurrent_get_ocd_pin ( hallcurrent_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _HALLCURRENT_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END