Implementation of 1-Wire with added Alarm Search Functionality
Dependents: Max32630_One_Wire_Interface
OneWire_Masters/DS248x/ds248x.h
- Committer:
- IanBenzMaxim
- Date:
- 2016-03-21
- Revision:
- 21:00c94aeb533e
- Parent:
- 17:b646b1e3970b
- Child:
- 23:e8e403d61359
File content as of revision 21:00c94aeb533e:
/******************************************************************//** * 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 DS248X_H #define DS248X_H #include "mbed.h" #include "OneWireInterface.h" #include "OneWireMaster.h" class Ds248x: public OneWireMaster { public: enum DS248X_I2C_ADRS { DS248X_I2C_ADRS0 = 0x18, DS248X_I2C_ADRS1, DS248X_I2C_ADRS2, DS248X_I2C_ADRS3, DS248X_I2C_ADRS4, DS248X_I2C_ADRS5, DS248X_I2C_ADRS6, DS248X_I2C_ADRS7 }; enum DS248X_CMDS { CMD_DRST = 0xF0, CMD_WCFG = 0xD2, CMD_A1WP = 0xC3, //DS2484 only CMD_CHSL = 0xC3, //DS2482-800 only CMD_SRP = 0xE1, CMD_1WRS = 0xB4, CMD_1WWB = 0xA5, CMD_1WRB = 0x96, CMD_1WSB = 0x87, CMD_1WT = 0x78 }; enum DS248X_CONFIG_BITS { CONFIG_APU = 0x01, CONFIG_PDN = 0x02, CONFIG_SPU = 0x04, CONFIG_1WS = 0x08 }; enum DS248X_STATUS_BITS { STATUS_1WB = 0x01, STATUS_PPD = 0x02, STATUS_SD = 0x04, STATUS_LL = 0x08, STATUS_RST = 0x10, STATUS_SBR = 0x20, STATUS_TSB = 0x40, STATUS_DIR = 0x80 }; enum DS2484_ADJST_PARAMS { TRSTL = 0, TRSTL_OD, TMSP, TMSP_OD, TW0L, TW0L_OD, TREC0, //OD NA RWPU = 8 //OD NA, see DS2484 datasheet page 13 }; enum SEARCH_DIRECTION { DIRECTION_WRITE_ZERO = 0, DIRECTION_WRITE_ONE = 1 }; static const size_t POLL_LIMIT = 200; static const int I2C_WRITE_OK = 0; static const int I2C_READ_OK = 0; /** * Member functions that directly support DS248x I2C to 1-wire * masters are documented in this file. Virtual function * inerited from the interface class 'OneWireInterface' * are documented in 'OneWireInterface.h', trying to follow * a 'DRY' methodology, Don't Repeat Yourself. */ /**********************************************************//** * @brief Ds248x constructor * * @details allows user to use existing I2C object * * On Entry: * @param[in] p_i2c_bus - pointer to existing I2C object * * On Exit: * @return **************************************************************/ Ds248x(I2C &i2c_bus, DS248X_I2C_ADRS adrs); /**********************************************************//** * @brief Ds248x constructor * * @details Object instantiates a new I2C object with no * public access * * On Entry: * @param[in] sda - sda pin of I2C bus * @param[in] scl - scl pin of I2C bus * * On Exit: * @return **************************************************************/ Ds248x(PinName sda, PinName scl, DS248X_I2C_ADRS adrs); /**********************************************************//** * @brief Ds248x destructor * * @details deletes I2C object if owner * * On Entry: * * On Exit: * @return **************************************************************/ virtual ~Ds248x(); /**********************************************************//** * @brief detect() * * @details Detect routine that performs a device reset * followed by writing the configuration byte to default * values: * 1-Wire speed (c1WS) = standard (0) * Strong pull-up (cSPU) = off (0) * Presence pulse masking (cPPM) = off (0) * Active pull-up (cAPU) = on (CONFIG_APU = 0x01) * * On Entry: * * On Exit: * @return TRUE if device was detected and written * FALSE device not detected or failure to write * configuration byte **************************************************************/ OneWireInterface::CmdResult detect(void); /**********************************************************//** * @brief reset() * * @details Perform a device reset on the Ds248x * * On Entry: * * On Exit: * @return TRUE if device was reset * FALSE device not detected or failure to perform reset **************************************************************/ OneWireInterface::CmdResult reset(void); /**********************************************************//** * @brief write_config() * * @details Write the configuration register in the Ds248x. The * configuration options are provided in the lower nibble * of the provided config byte. The uppper nibble is * bitwise inverted when written to the Ds248x. * * On Entry: * @param[in] config - lower nib of configuration register * * On Exit: * @return TRUE: config written and response correct * FALSE: response incorrect **************************************************************/ OneWireInterface::CmdResult write_config(uint8_t config); /**********************************************************//** * @brief channel_select() * * @details Select the 1-Wire channel on a DS2482-800. * Min channel = 1 * * On Entry: * @param[in] channel - desired channel of the DS2482 * * On Exit: * @return TRUE if channel selected * FALSE device not detected or failure to perform select **************************************************************/ OneWireInterface::CmdResult channel_select(uint8_t channel); /**********************************************************//** * @brief adjust_timing() * * @details adjustable timming available in DS2484 only * * On Entry: * @param[in] param - 1 of 8 adjustable parameters * @param[in] val - new value for parameter, see datasheet * for codes * * On Exit: * @return TRUE: parameter successfully adjusted * FALSE: failed to adjust parameter **************************************************************/ OneWireInterface::CmdResult adjust_timing(uint8_t param, uint8_t val); /**********************************************************//** * @brief search_triplet() * * @details Use the Ds248x help command '1-Wire triplet' to perform * one bit of a 1-Wire search. This command does two read * bits and one write bit. The write bit is either the * default direction (all device have same bit) or in case * of a discrepancy, the 'search_direction' parameter is * used. * * On Entry: * @param[in] search_direction * * On Exit: * @return The Ds248x status byte result from the triplet command **************************************************************/ OneWireInterface::CmdResult search_triplet(uint8_t search_direction, uint8_t & status); //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); virtual OneWireInterface::CmdResult OWReadBytePower(uint8_t & recvbyte); private: //private fx for initializing _w_adrs and _r_adrs void set_i2c_adrs(DS248X_I2C_ADRS adrs); I2C *_p_i2c_bus; uint8_t _w_adrs, _r_adrs; bool _i2c_owner; // ds248x state uint8_t _short_detected; uint8_t _c1WS, _cSPU, _cPDN, _cAPU; }; #endif /*DS248X_H*/