Implementation of 1-Wire with added Alarm Search Functionality

Dependents:   Max32630_One_Wire_Interface

Switches/DS2413/DS2413.cpp

Committer:
IanBenzMaxim
Date:
2016-05-12
Revision:
73:2cecc1372acc
Parent:
OneWire_Switches/DS2413/ds2413.cpp@ 56:be69bd88a3e3
Child:
74:23be10c32fa3

File content as of revision 73:2cecc1372acc:

/******************************************************************//**
* Copyright (C) 2016 Maxim Integrated Products, Inc., 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 MAXIM INTEGRATED 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.
*
* Except as contained in this notice, the name of Maxim Integrated
* Products, Inc. shall not be used except as stated in the Maxim Integrated
* Products, Inc. Branding Policy.
*
* The mere transfer of this software does not imply any licenses
* of trade secrets, proprietary technology, copyrights, patents,
* trademarks, maskwork rights, or any other form of intellectual
* property whatsoever. Maxim Integrated Products, Inc. retains all
* ownership rights.
**********************************************************************/

#include "DS2413.h"
#include "Masters/OneWireMasters.h"

using OneWire::Switches::DS2413;
using OneWire::Masters::OneWireMaster;

//*********************************************************************
DS2413::DS2413(OneWireMaster &owm): _owm(owm)
{
}


//*********************************************************************
DS2413::CmdResult DS2413::pio_access_read_chA(uint8_t & val)
{
  DS2413::CmdResult result = OpFailure;
  
  result = pio_access_read(val);
  
  val = (val & 0x01);
  
  return result;
}


//*********************************************************************
DS2413::CmdResult DS2413::pio_access_read_chB(uint8_t & val)
{
  DS2413::CmdResult result = OpFailure;
  
  result = pio_access_read(val);
  
  val = ((val >> 2) & 0x01);
  
  return result;
}


//*********************************************************************
DS2413::CmdResult DS2413::pio_access_write_chA(uint8_t val)
{
  DS2413::CmdResult result = OpFailure;
  
  uint8_t local_val = 0;
  
  //read current state of PIO
  result = pio_access_read(local_val);
  
  if(result == DS2413::Success)
  {
    //modify
    //current state of pioB OR
    //desired state of pioA OR
    //bits[7:2] should all be 1, per datasheet
    val = (0xFC | (((local_val >> 1) & 0x02) | (0x01 & val)));
    
    //write, bit[1:0] new state of pio
    result = pio_access_write(val);
  }
  
  return result;
}


//*********************************************************************
DS2413::CmdResult DS2413::pio_access_write_chB(uint8_t val)
{
  DS2413::CmdResult result = OpFailure;
  
  uint8_t local_val = 0;
  
  //read current state of PIO
  result = pio_access_read(local_val);
  
  if(result == DS2413::Success)
  {
    //modify
    //current state of pioA OR
    //desired state of pioB OR
    //bits[7:2] should all be 1, per datasheet
    val = (0xFC | ((local_val & 0x01) | (0x02 & (val << 1))));
    
    //write, bit[1:0] new state of pio
    result = pio_access_write(val);
  }
  
  return result;
}


//*********************************************************************
DS2413::CmdResult DS2413::pio_access_write_chAB(uint8_t val)
{
    return pio_access_write((0x03 & val) | 0xFC);
}


//*********************************************************************
DS2413::CmdResult DS2413::pio_access_read(uint8_t & val)
{
  DS2413::CmdResult result = DS2413::OpFailure;
  
  OneWireMaster::CmdResult ow_result = _owm.OWMatchROM(romId);
  
  if(ow_result == OneWireMaster::Success)
  {
    ow_result = _owm.OWWriteByte(DS2413::PIO_ACCESS_READ);
    
    if(ow_result == OneWireMaster::Success)
    {
      ow_result = _owm.OWReadByte(val);
      
      if(ow_result == OneWireMaster::Success)
      {
        result = DS2413::Success;
      }
      else
      {
        result = DS2413::CommsReadError;
      }
    }
    else
    {
      result = DS2413::CommsWriteError;
    }
  }
  
  return result;
}


//*********************************************************************
DS2413::CmdResult DS2413::pio_access_write(uint8_t val)
{
  DS2413::CmdResult result = DS2413::OpFailure;
  
  OneWireMaster::CmdResult ow_result = _owm.OWMatchROM(romId);
  
  if(ow_result == OneWireMaster::Success)
  {
    uint8_t send_block[] = {DS2413::PIO_ACCESS_WRITE, val, ~val};
    
    ow_result = _owm.OWWriteBlock(send_block, 3);
    if(ow_result == OneWireMaster::Success)
    {
      uint8_t expected_status = ((0x01 & val) | ((0x01 & val) << 1) | 
                                ((0x02 & val) << 1) | ((0x02 & val) << 2));
      
      uint8_t rcv_block[2];
      ow_result = _owm.OWReadBlock(rcv_block, 2);
      
      if(ow_result == OneWireMaster::Success)
      {
        if((rcv_block[0] == 0xAA) && ((rcv_block[1] & 0x0F) == expected_status))
        {
          result = DS2413::Success;
        }
      }
      else
      {
        result = DS2413::CommsReadError;
      }
    }
    else
    {
      result = DS2413::CommsWriteError;
    }
  }
  
  return result;
}