onewire.h

Go to the documentation of this file.

/* Copyright 2012-2014, 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 BSP430_UTILITY_ONEWIRE_H
#define BSP430_UTILITY_ONEWIRE_H

#include <bsp430/periph/port.h>

typedef struct sBSP430onewireBus {
  hBSP430halPORT port;
  unsigned char bit;
} sBSP430onewireBus;

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

enum {
  BSP430_ONEWIRE_CMD_READ_ROM = 0x33,

  BSP430_ONEWIRE_CMD_SKIP_ROM = 0xcc,

  BSP430_ONEWIRE_CMD_READ_POWER_SUPPLY = 0xb4,

  BSP430_ONEWIRE_CMD_RECALL_EE = 0xb8,

  BSP430_ONEWIRE_CMD_READ_SCRATCHPAD = 0xbe,

  BSP430_ONEWIRE_CMD_CONVERT_T = 0x44,
};

int iBSP430onewireReset_ni (const sBSP430onewireBus * bus);

void vBSP430onewireShutdown_ni (const sBSP430onewireBus * bus);

void vBSP430onewireWriteByte_ni (const sBSP430onewireBus * bus,
                                 int byte);

int iBSP430onewireReadBit_ni (const sBSP430onewireBus * bus);

int iBSP430onewireReadByte_ni (const sBSP430onewireBus * bus);

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

int iBSP430onewireReadSerialNumber (const sBSP430onewireBus * bus,
                                    sBSP430onewireSerialNumber * snp);

int iBSP430onewireReadPowerSupply (const sBSP430onewireBus * bus);

int iBSP430onewireRequestTemperature_ni (const sBSP430onewireBus * bus);

static BSP430_CORE_INLINE
int
iBSP430onewireTemperatureReady_ni (const sBSP430onewireBus * bus)
{
  return iBSP430onewireReadBit_ni(bus);
}

int iBSP430onewireReadTemperature_ni (const sBSP430onewireBus * bus,
                                      int * temp_xCel);

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

#define BSP430_ONEWIRE_xCel_TO_dK(xcel_) ((21852U + 5U * (xcel_)) / 8U)

#endif /* BSP430_UTILITY_ONEWIRE_H */