Superseded by MaximInterface.

File content as of revision 17:b646b1e3970b:

/******************************************************************//**
* 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 DS2480B_H
#define DS2480B_H


#include "mbed.h"
#include "OneWireInterface.h"
#include "OneWireMaster.h"


class Ds2480b: public OneWireMaster
{
    public:
    
    /**********************************************************//**
    * @brief Ds2480b constructor
    * 
    * @details allows user to use existing Serial object
    *
    * On Entry:
    *     @param[in] p_serial - pointer to existing serial object
    *
    * On Exit:
    *    @return 
    **************************************************************/
    Ds2480b(Serial &p_serial);
    
    
    /**********************************************************//**
    * @brief Ds2480b constructor
    * 
    * @details Object instantiates a new serial object with no 
    *          public access
    *
    * On Entry:
    *     @param[in] tx - tx pin of uart to be used
    *     @param[in] rx - rx pin of uart to be used
    *     @param[in] baud - baudrate for uart
    *
    * On Exit:
    *    @return 
    **************************************************************/
    Ds2480b(PinName tx, PinName rx, uint32_t baud);
    
    
    /**********************************************************//**
    * @brief Ds2480b destructor 
    * 
    * @details deletes serial object if owner 
    *
    * On Entry:
    *
    * On Exit:
    *    @return 
    **************************************************************/
    virtual ~Ds2480b();
    
    
    //Part of OneWireInterface that should be implemented for each master
    //See OneWireInterface.h for documentation
    
    virtual OneWireInterface::CmdResult OWInitMaster(void);
    
    virtual OneWireInterface::CmdResult OWReset(void);
    
    virtual OneWireInterface::CmdResult OWTouchBit(uint8_t & sendrecvbit);

    virtual OneWireInterface::CmdResult OWWriteByte(uint8_t sendbyte);

    virtual OneWireInterface::CmdResult OWReadByte(uint8_t & recvbyte);
    
    virtual OneWireInterface::CmdResult OWWriteBlock(const uint8_t *tran_buf, uint8_t tran_len);
    
    virtual OneWireInterface::CmdResult OWReadBlock(uint8_t *rx_buf, uint8_t rx_len);
    
    virtual OneWireInterface::CmdResult OWSearch(RomId & romId);

    virtual OneWireInterface::CmdResult OWSpeed(OW_SPEED new_speed);

    virtual OneWireInterface::CmdResult OWLevel(OW_LEVEL new_level);

    virtual OneWireInterface::CmdResult OWWriteBytePower(uint8_t sendbyte);

    virtual OneWireInterface::CmdResult OWReadBitPower(uint8_t applyPowerResponse);
    
    private:
    
    Serial *_p_serial;
    bool _serial_owner;
};

#endif /*DS2480B_H*/