Implementation of 1-Wire with added Alarm Search Functionality
Dependents: Max32630_One_Wire_Interface
Diff: Slaves/Bridges/DS28E17/DS28E17.h
- Revision:
- 95:5ebdf5d955f4
- Parent:
- 93:e496a45ce796
- Child:
- 101:e7f76cb49584
--- a/Slaves/Bridges/DS28E17/DS28E17.h Fri Jun 24 21:12:26 2016 +0000 +++ b/Slaves/Bridges/DS28E17/DS28E17.h Fri Jun 24 21:24:02 2016 +0000 @@ -79,15 +79,11 @@ /**********************************************************//** * @brief DS28E17 constructor * - * @details * * On Entry: - * @param[in] p_owm - pointer to a 1-wire master of the following - * types; Ds248x, Ds2480b, OwGpio which - * inherit the base class 'OneWireInterface' - * - * On Exit: - * @return + * @param[in] selector - RandomAccessRomIterator object that + * encapsulates master associated with this device and rom control + * commands **************************************************************/ DS28E17(RandomAccessRomIterator &selector); @@ -123,9 +119,7 @@ * all bytes were acknowledged by the slave. * A non-zero value indicates the byte number that NACK’d. * - * @return - * true if device selected and written @n - * false if failed device select + * @return CmdResult - result of operation **************************************************************/ CmdResult I2C_WriteDataWithStop(uint8_t I2C_addr, uint8_t length, uint8_t *data, uint8_t &status, @@ -163,9 +157,7 @@ * all bytes were acknowledged by the slave. * A non-zero value indicates the byte number that NACK’d. * - * @return - * true if device selected and written @n - * false if failed device select + * @return CmdResult - result of operation **************************************************************/ CmdResult I2C_WriteDataNoStop(uint8_t I2C_addr, uint8_t length, uint8_t *data, uint8_t &status, @@ -199,9 +191,7 @@ * Indicates which write byte NACK’d. A value of 00h indicates all bytes were acknowledged by the slave. * A non-zero value indicates the byte number that NACK’d. * - * @return - * true if device selected and written @n - * false if failed device select + * @return CmdResult - result of operation **************************************************************/ CmdResult I2C_WriteDataOnly(uint8_t length, uint8_t *data, uint8_t &status, uint8_t &wr_status); @@ -234,9 +224,7 @@ * Indicates which write byte NACK’d. A value of 00h indicates all bytes were acknowledged by the slave. * A non-zero value indicates the byte number that NACK’d. * - * @return - * true if device selected and written @n - * false if failed device select + * @return CmdResult - result of operation **************************************************************/ CmdResult I2C_WriteDataOnlyWithStop(uint8_t length, uint8_t *data, uint8_t &status, uint8_t &wr_status); @@ -281,9 +269,7 @@ * @param[out] *read_data * Array of read data received from I2C. * - * @return - * true if device selected, written and read @n - * false if failed device select or timeout occurred or CRC16 error + * @return CmdResult - result of operation **************************************************************/ CmdResult I2C_WriteReadDataWithStop(uint8_t I2C_addr, uint8_t length, uint8_t *data, uint8_t nu_bytes_read, @@ -319,9 +305,7 @@ * @param[out] *read_data * Array of read data received from I2C. * - * @return - * true if device selected, written and read @n - * false if failed device select or timeout occurred or CRC16 error + * @return CmdResult - result of operation **************************************************************/ CmdResult I2C_ReadDataWithStop(uint8_t I2C_addr, uint8_t nu_bytes_read, uint8_t &status, uint8_t *read_data); @@ -336,11 +320,7 @@ * @param[in] data * sent to configuration register * - * On Exit: - * - * @return - * true if device selected and written @n - * false if failed device select + * @return CmdResult - result of operation **************************************************************/ CmdResult WriteConfigReg(uint8_t data); @@ -350,13 +330,10 @@ * * @details * - * On Entry: - * * On Exit: + * @param[out] config - contents of configuration register * - * @return - * true if device selected and read correctly @n - * false if failed device select + * @return CmdResult - result of operation **************************************************************/ CmdResult ReadConfigReg(uint8_t & config); @@ -367,15 +344,7 @@ * the command, the device monitors the WAKEUP input pin and * exits sleep mode on a rising edge. * - * @details - * - * On Entry: - * - * On Exit: - * - * @return - * true if device selected and written @n - * false if failed device select* + * @return CmdResult - result of operation **************************************************************/ CmdResult EnableSleepMode(); @@ -385,15 +354,10 @@ * should never be zero. The upper nibble is the major revision * and the lower nibble is the minor revision. * - * @details - * - * On Entry: + * On Exit: + * @param[out] rev - device revision * - * On Exit: - * - * @return - * revision value if device selected and read correctly @n - * false if failed device select (i.e. 00h) + * @return CmdResult - result of operation **************************************************************/ CmdResult ReadDeviceRevision(uint8_t & rev);