onewire.h

Go to the documentation of this file.

/* Copyright 2012-2015, Peter A. Bigot
 *
 * All rights reserved.
 *
 * 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.
 *
 * * Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * * Neither the name of the software 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 COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT HOLDER OR CONTRIBUTORS 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.
 */

#ifndef BSPACM_UTILITY_ONEWIRE_H
#define BSPACM_UTILITY_ONEWIRE_H

#include <bspacm/core.h>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/* Forward declaration.  Definition found in device-specific header
 * included below. */
struct sBSPACMonewireBus;

typedef const struct sBSPACMonewireBus * hBSPACMonewireBus;

typedef struct sBSPACMonewireSerialNumber {
  uint8_t id[6];
} sBSPACMonewireSerialNumber;

enum {
  BSPACM_ONEWIRE_T_RSTL_us = 480,

  BSPACM_ONEWIRE_T_RSTH_us = 480,

  BSPACM_ONEWIRE_T_PDHIGH_us = 60,

  BSPACM_ONEWIRE_T_LOW0_us = 60,

  BSPACM_ONEWIRE_T_LOW1_us = 1,

  BSPACM_ONEWIRE_T_REC_us = 1,

  BSPACM_ONEWIRE_T_INT_us = 1,

  BSPACM_ONEWIRE_T_RDV_us = 15 - BSPACM_ONEWIRE_T_INT_us,

  BSPACM_ONEWIRE_T_SLOT_us = 60,
};

enum {
  BSPACM_ONEWIRE_CMD_READ_ROM = 0x33,

  BSPACM_ONEWIRE_CMD_SKIP_ROM = 0xcc,

  BSPACM_ONEWIRE_CMD_READ_POWER_SUPPLY = 0xb4,

  BSPACM_ONEWIRE_CMD_RECALL_EE = 0xb8,

  BSPACM_ONEWIRE_CMD_READ_SCRATCHPAD = 0xbe,

  BSPACM_ONEWIRE_CMD_CONVERT_T = 0x44,
};

int iBSPACMonewireReset (hBSPACMonewireBus bus);

void vBSPACMonewireShutdown (hBSPACMonewireBus bus);

void
vBSPACMonewireParasitePower (hBSPACMonewireBus bus,
                             bool powered);

void vBSPACMonewireWriteByte (hBSPACMonewireBus bus,
                              uint8_t byte);

int iBSPACMonewireReadBit (hBSPACMonewireBus bus);

int iBSPACMonewireReadByte (hBSPACMonewireBus bus);

int iBSPACMonewireComputeCRC (const unsigned char * data, int len);

int iBSPACMonewireReadSerialNumber (hBSPACMonewireBus bus,
                                    sBSPACMonewireSerialNumber * snp);

int iBSPACMonewireReadPowerSupply (hBSPACMonewireBus bus);

int iBSPACMonewireRequestTemperature (hBSPACMonewireBus bus);

static BSPACM_CORE_INLINE
int
iBSPACMonewireTemperatureReady (hBSPACMonewireBus bus)
{
  return iBSPACMonewireReadBit(bus);
}

int iBSPACMonewireReadTemperature (hBSPACMonewireBus bus,
                                   int16_t * temp_xCel);

#define BSPACM_ONEWIRE_xCel_TO_dCel(xcel_) ((10 * (xcel_)) / 16)

#define BSPACM_ONEWIRE_xCel_TO_ddegF(xcel_) (320 + ((9 * (xcel_)) / 8))

#define BSPACM_ONEWIRE_xCel_TO_dK(xcel_) ((unsigned int)(21852U + 5U * (xcel_)) / 8U)

/* Include the device-specific header which defines struct
 * sBSPACMonewireBus and provides hBSPACMonewireConfigureBus(). */
#include <bspacm/utility/onewire_.h>

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* BSPACM_UTILITY_ONEWIRE_H */