comparator.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright (c) 2019, MikroElektronika - www.mikroe.com
 * All rights reserved.
 *
 * 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 COMPARATOR_H
#define COMPARATOR_H
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_in.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define COMPARATOR_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.o1 = MIKROBUS( mikrobus, MIKROBUS_AN );    \
  cfg.o2 = MIKROBUS( mikrobus, MIKROBUS_INT )
#define COMPARATOR_RETVAL  uint8_t
 
#define COMPARATOR_OK                            0x00
#define COMPARATOR_INIT_ERROR                    0xFF
#define COMPARATOR_STATE_LOW                     0x00
#define COMPARATOR_STATE_HIGH                    0x01
 // End group macro 
 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
 
    // Input pins 
 
    digital_in_t o1;
    digital_in_t o2;
 
} comparator_t;
 
typedef struct
{
    // Additional gpio pins 
 
    pin_name_t o1;
    pin_name_t o2;
 
} comparator_cfg_t;
 
 // End types group
 
// ------------------------------------------------------------------ CONSTANTS
 // End constants group
 
// ------------------------------------------------------------------ VARIABLES
 // End variable group
 
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void comparator_cfg_setup ( comparator_cfg_t *cfg );
 
COMPARATOR_RETVAL comparator_init ( comparator_t *ctx, comparator_cfg_t *cfg );
 
uint8_t comparator_check_output_one ( comparator_t *ctx );
 
uint8_t comparator_check_output_two ( comparator_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _COMPARATOR_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END