clickid.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 CLICKID_H
#define CLICKID_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_one_wire.h"
 
#define CLICKID_CMD_WRITE_MEMORY            0x96
#define CLICKID_CMD_READ_MEMORY             0x69
#define CLICKID_CMD_RELEASE                 0xAA
 
 // clickid_cmd
 
#define CLICKID_MEM_ACCESS_SUCCESS          0xAA
#define CLICKID_MEM_ACCESS_FAIL             0x55
 
#define CLICKID_USER_EEPROM_START           0x0000
#define CLICKID_USER_EEPROM_END             0x01FF
#define CLICKID_PAGE_START                  0x00
#define CLICKID_PAGE_END                    0x1F
#define CLICKID_PAGE_SIZE                   32
#define CLICKID_MANIFEST_START_ADDRESS      0x0020
 
#define CLICKID_FAMILY_CODE                 0xCC
 
 // clickid_set
 
#define CLICKID_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS );
 
 // clickid_map
 // clickid
 
typedef struct
{
    uint8_t major; 
    uint8_t minor;
    
} clickid_version_t;
 
typedef struct
{
    clickid_version_t hw_rev;           
    uint16_t serial;                    
    uint16_t type;                      
    uint8_t custom;                     
    uint8_t name[ 20 ];                 
} clickid_information_t;
 
typedef struct
{
    // Output pins
    digital_out_t rst;                  
    // Modules
    one_wire_t ow;                      
    one_wire_rom_address_t rom_addr;    
} clickid_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t cs;                      
    // Additional gpio pins
    pin_name_t rst;                     
} clickid_cfg_t;
 
typedef enum
{
    CLICKID_OK = 0,
    CLICKID_ERROR = -1
 
} clickid_return_value_t;
 
void clickid_cfg_setup ( clickid_cfg_t *cfg );
 
err_t clickid_init ( clickid_t *ctx, clickid_cfg_t *cfg );
 
void clickid_deinit ( clickid_t *ctx );
 
err_t clickid_check_communication ( clickid_t *ctx );
 
err_t clickid_read_memory ( clickid_t *ctx, uint16_t address, uint8_t *data_out, uint16_t len );
 
err_t clickid_write_memory ( clickid_t *ctx, uint16_t address, uint8_t *data_in, uint16_t len );
 
err_t clickid_read_information ( clickid_t *ctx, clickid_information_t *info );
 
#ifdef __cplusplus
}
#endif
#endif // CLICKID_H
 
 // clickid
 
// ------------------------------------------------------------------------ END