This file is part of OneWire routines

by Isaac Marino Bavaresco

/*============================================================================*/
/*
 Copyright (c) 2016-2019, Isaac Marino Bavaresco
 All rights reserved.
 isaacbavaresco@yahoo.com.br

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
     * Redistributions of source code must retain the above copyright
       notice, this list of conditions and the following disclaimer.
     * Neither the name of the author nor the
       names of its contributors may be used to endorse or promote products
       derived from this software without specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ''AS IS'' AND ANY
 EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/*============================================================================*/
#if         !defined __ONEWIRE_H__
#define __ONEWIRE_H__
/*============================================================================*/
#include "OneWireHAL-PIC16F.h"
/*============================================================================*/
#define ONE_WIRE_SERIAL_NUMBER_SIZE      8
/*============================================================================*/
#define ONE_WIRE_COMMAND_READ_ROM     0x33
#define ONE_WIRE_COMMAND_MATCH_ROM    0x55
#define ONE_WIRE_COMMAND_SKIP_ROM     0xCC
#define ONE_WIRE_COMMAND_SEARCH_ROM   0xF0
/*============================================================================*/
#define ONE_WIRE_SEARCH_STATUS_FOUND     0
#define ONE_WIRE_SEARCH_STATUS_NOT_FOUND -1
/*============================================================================*/
#define ONE_WIRE_STATUS_OK               0
#define ONE_WIRE_STATUS_NO_RESPONSE     -1
#define ONE_WIRE_STATUS_CRC_ERROR       -2
#define ONE_WIRE_STATUS_BUS_CONTENTION  -3
/*============================================================================*/
typedef struct
    {
    struct
        {
        unsigned char   NumberOfFixedBits   : 6;
        unsigned char   FirstSearch         : 1;
        unsigned char   Finished            : 1;
        };

    unsigned char       SerialNumber[ONE_WIRE_SERIAL_NUMBER_SIZE];
    unsigned char       Branches[ONE_WIRE_SERIAL_NUMBER_SIZE];
    } onewiresearch_t;
/*============================================================================*/
typedef struct
    {
    unsigned char       Bytes[ONE_WIRE_SERIAL_NUMBER_SIZE];
    } ibuttonsn_t;
/*============================================================================*/
onewirestatus_t OneWireInit             ( void );
onewirestatus_t OneWireReset            ( void );
onewirestatus_t OneWireWriteByte        ( unsigned char Value );
int             OneWireReadByte         ( void );
unsigned char   CalcCRC8                ( unsigned char Seed, unsigned char Value );

void            OneWireSearchInit       ( onewiresearch_t *SearchStruct, int FamilyCode );
onewirestatus_t OneWireSearch           ( onewiresearch_t *SearchStruct, ibuttonsn_t *SerialNumber );

onewirestatus_t OneWireMatchROM         ( const ibuttonsn_t *SerialNumber );
onewirestatus_t OneWireReadSerialNumber ( ibuttonsn_t *Buffer );
/*============================================================================*/
/*
The functions below are supplied by the HAL layer.
*/
/*============================================================================*/
onewirestatus_t OneWireWriteZero    ( void );
onewirestatus_t OneWireWriteOne     ( void );
onewirestatus_t OneWireReadBit      ( void );
/*============================================================================*/
#endif  /*  !defined __ONEWIRE_H__ */
/*============================================================================*/