Implementation of 1-Wire with added Alarm Search Functionality
Dependents: Max32630_One_Wire_Interface
Diff: Masters/DS2480B/DS2480B.h
- Revision:
- 73:2cecc1372acc
- Parent:
- 72:6892702709ee
- Child:
- 74:23be10c32fa3
diff -r 6892702709ee -r 2cecc1372acc Masters/DS2480B/DS2480B.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Masters/DS2480B/DS2480B.h Thu May 12 14:38:16 2016 -0500 @@ -0,0 +1,155 @@ +/******************************************************************//** +* 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_Masters_DS2480B +#define OneWire_Masters_DS2480B + +#include "PinNames.h" +#include "Masters/OneWireMaster.h" + +namespace mbed { class Serial; } + +namespace OneWire +{ + namespace Masters + { + class DS2480B : public OneWireMaster + { + public: + + enum DS2480B_BPS + { + BPS_9600 = 0, + BPS_19200 = 2, + BPS_57600 = 4, + BPS_115200 = 6 + }; + + /**********************************************************//** + * @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(mbed::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); + + + /**********************************************************//** + * @brief DS2480B destructor + * + * @details deletes serial object if owner + * + * On Entry: + * + * On Exit: + * @return + **************************************************************/ + virtual ~DS2480B(); + + OneWireMaster::CmdResult DS2480B_ChangeBaud(DS2480B_BPS newbaud); + + + //Part of OneWireMaster that should be implemented for each master + //See OneWireMaster.h for documentation + + virtual OneWireMaster::CmdResult OWInitMaster(void); + + virtual OneWireMaster::CmdResult OWReset(void); + + virtual OneWireMaster::CmdResult OWTouchBitSetLevel(uint8_t & sendrecvbit, OWLevel after_level); + + virtual OneWireMaster::CmdResult OWWriteByteSetLevel(uint8_t sendbyte, OWLevel after_level); + + virtual OneWireMaster::CmdResult OWReadByteSetLevel(uint8_t & recvbyte, OWLevel after_level); + + virtual OneWireMaster::CmdResult OWSetSpeed(OWSpeed new_speed); + + virtual OneWireMaster::CmdResult OWSetLevel(OWLevel new_level); + + private: + + void rx_callback(void); + + OneWireMaster::CmdResult DS2480B_Detect(void); + OneWireMaster::CmdResult WriteCOM(uint32_t outlen, uint8_t *outbuf); + OneWireMaster::CmdResult ReadCOM(uint32_t inlen, uint8_t *inbuf); + void BreakCOM(void); + void FlushCOM(void); + void SetBaudCOM(uint8_t new_baud); + int32_t bitacc(uint32_t op, uint32_t state, uint32_t loc, uint8_t *buf); + + mbed::Serial *_p_serial; + bool _serial_owner; + + // DS2480B state + OWLevel _ULevel; // 1-Wire level + DS2480B_BPS _UBaud; // baud rate + uint8_t _UMode; // command or data mode state + uint8_t _USpeed; // 1-Wire communication speed + + static const size_t MAX_RX_BUFFER_LEN = 256; + volatile struct ds2480b_circular_buff_s + { + uint8_t w_idx; + uint8_t r_idx; + uint8_t rx_bytes_available; + bool wrap_error; + uint8_t buff[MAX_RX_BUFFER_LEN]; + }rx_buffer; + }; + } +} + +#endif /*DS2480B_H*/ +