Superseded by MaximInterface.

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.
**********************************************************************/

#ifndef OneWire_Switches_DS2413
#define OneWire_Switches_DS2413

#include <stdint.h>
#include "OneWireSlave.h"

namespace OneWire
{
  namespace Masters { class OneWireMaster; }
  
  namespace Switches
  {
    class DS2413 : public OneWireSlave
    {
    public:
      
      enum DS2413_CMDS
      {
        PIO_ACCESS_READ = 0xF5,
        PIO_ACCESS_WRITE = 0x5A
      };
      
      enum DS2413_PIO
      {
        PIOA,
        PIOB,
        PIOAB
      };
      
      enum CmdResult
      {
        Success,
        CommsReadError,
        CommsWriteError,
        OpFailure
      };
      
      /**********************************************************//**
      * @brief DS2413 constructor
      * 
      * @details 
      *
      * On Entry:
      *     @param[in] owm - reference to 1-wire master
      *
      * On Exit:
      *
      * @return 
      **************************************************************/
      DS2413(Masters::OneWireMaster &owm);
      

      /**********************************************************//**
      * @brief pio_access_read_chA()
      * 
      * @details reads state of pio
      *
      * On Entry:
      *     @param[in] romId - refernce to ROM # of switch
      *
      * On Exit:
      *     @param[out] val - lsb represents the state of the pio
      *
      * @return CmdResult - result of operation
      **************************************************************/
      CmdResult pio_access_read_chA(uint8_t & val);
      
      
      /**********************************************************//**
      * @brief pio_access_read_chB()
      * 
      * @details reads state of pio
      *
      * On Entry:
      *     @param[in] romId - refernce to ROM # of switch
      *
      * On Exit:
      *     @param[out] val - lsb represents the state of the pio
      *
      * @return CmdResult - result of operation
      **************************************************************/
      CmdResult pio_access_read_chB(uint8_t & val);
      
      
      /**********************************************************//**
      * @brief pio_acess_write_chA()
      * 
      * @details writes to pio
      *
      * On Entry:
      *    @param[in] romId - refernce to ROM # of switch
      *    @param[in] val - lsb sets state of pio
      *
      * On Exit:
      *
      * @return CmdResult - result of operation
      **************************************************************/
      CmdResult pio_access_write_chA(uint8_t val);
      
      
      /**********************************************************//**
      * @brief pio_acess_write_chB()
      * 
      * @details writes to pio
      *
      * On Entry:
      *    @param[in] romId - refernce to ROM # of switch
      *    @param[in] val - lsb sets state of pio
      *
      * On Exit:
      *
      * @return CmdResult - result of operation
      **************************************************************/
      CmdResult pio_access_write_chB(uint8_t val);
      
      
      /**********************************************************//**
      * @brief pio_acess_write_chAB()
      * 
      * @details writes to pio
      *
      * On Entry:
      *    @param[in] romId - refernce to ROM # of switch
      *    @param[in] val - Bits 1:0 set PIOB and PIOB respectively
      *
      * On Exit:
      *
      * @return CmdResult - result of operation
      **************************************************************/
      CmdResult pio_access_write_chAB(uint8_t val);
      

    private:
      
      CmdResult pio_access_read(uint8_t & val);
      
      CmdResult pio_access_write(uint8_t val);
      
      Masters::OneWireMaster &_owm;
      
    };
  }
}

#endif /*DS2413_H*/