Mike Fruge / OneWire

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   Max32630_One_Wire_Interface

OneWire_Masters/GPIO/owgpio.h@72:6892702709ee, 2016-05-09 (annotated)

Committer:
IanBenzMaxim
Date:
Mon May 09 16:20:56 2016 -0500
Revision:
72:6892702709ee
Parent:
71:562f5c702094 
Use distinct names to prevent hiding of overloads in derived classes.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
j3 3:644fc630f958 1 /******************************************************************//**
j3 3:644fc630f958 2 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
j3 3:644fc630f958 3 *
j3 3:644fc630f958 4 * Permission is hereby granted, free of charge, to any person obtaining a
j3 3:644fc630f958 5 * copy of this software and associated documentation files (the "Software"),
j3 3:644fc630f958 6 * to deal in the Software without restriction, including without limitation
j3 3:644fc630f958 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
j3 3:644fc630f958 8 * and/or sell copies of the Software, and to permit persons to whom the
j3 3:644fc630f958 9 * Software is furnished to do so, subject to the following conditions:
j3 3:644fc630f958 10 *
j3 3:644fc630f958 11 * The above copyright notice and this permission notice shall be included
j3 3:644fc630f958 12 * in all copies or substantial portions of the Software.
j3 3:644fc630f958 13 *
j3 3:644fc630f958 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
j3 3:644fc630f958 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
j3 3:644fc630f958 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
j3 3:644fc630f958 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
j3 3:644fc630f958 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
j3 3:644fc630f958 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
j3 3:644fc630f958 20 * OTHER DEALINGS IN THE SOFTWARE.
j3 3:644fc630f958 21 *
j3 3:644fc630f958 22 * Except as contained in this notice, the name of Maxim Integrated
j3 3:644fc630f958 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
j3 3:644fc630f958 24 * Products, Inc. Branding Policy.
j3 3:644fc630f958 25 *
j3 3:644fc630f958 26 * The mere transfer of this software does not imply any licenses
j3 3:644fc630f958 27 * of trade secrets, proprietary technology, copyrights, patents,
j3 3:644fc630f958 28 * trademarks, maskwork rights, or any other form of intellectual
j3 3:644fc630f958 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
j3 3:644fc630f958 30 * ownership rights.
j3 3:644fc630f958 31 **********************************************************************/
j3 3:644fc630f958 32
j3 3:644fc630f958 33
j3 3:644fc630f958 34 #ifndef OWGPIO_H
j3 3:644fc630f958 35 #define OWGPIO_H
j3 3:644fc630f958 36
j3 3:644fc630f958 37
j3 10:0df2cc66fc47 38 #if(TARGET_MAX32600)
j3 10:0df2cc66fc47 39
j3 10:0df2cc66fc47 40
j3 3:644fc630f958 41 #include "mbed.h"
IanBenzMaxim 24:8942d8478d68 42 #include "OneWire_Masters/OneWireMaster.h"
j3 3:644fc630f958 43
j3 3:644fc630f958 44
j3 15:f6cb0d906fb6 45 class OwGpio: public OneWireMaster
j3 3:644fc630f958 46 {
IanBenzMaxim 26:a361e3f42ba5 47 public:
IanBenzMaxim 28:057bb14d3cee 48
j3 3:644fc630f958 49 /**********************************************************//**
j3 10:0df2cc66fc47 50 * @brief Owgpio constructor
j3 10:0df2cc66fc47 51 *
j3 10:0df2cc66fc47 52 * @details Initializes given pin for open-drain operation
j3 10:0df2cc66fc47 53 *
j3 10:0df2cc66fc47 54 * On Entry:
j3 10:0df2cc66fc47 55 *
j3 10:0df2cc66fc47 56 * @para[in] ow_gpio - GPIO pin to use for One Wire bus
j3 10:0df2cc66fc47 57 *
j3 10:0df2cc66fc47 58 * @param[in] ext_spu - GPIO pin to use for Strong Pull-Up
j3 10:0df2cc66fc47 59 *
j3 10:0df2cc66fc47 60 * On Exit:
j3 10:0df2cc66fc47 61 *
j3 10:0df2cc66fc47 62 * @return
j3 10:0df2cc66fc47 63 **************************************************************/
j3 10:0df2cc66fc47 64 OwGpio(PinName ow_gpio, PinName ext_spu = NC);
j3 10:0df2cc66fc47 65
j3 10:0df2cc66fc47 66
j3 23:e8e403d61359 67 //Part of OneWireMaster that should be implemented for each master
j3 23:e8e403d61359 68 //See OneWireMaster.h for documentation
j3 15:f6cb0d906fb6 69
j3 23:e8e403d61359 70 virtual OneWireMaster::CmdResult OWInitMaster(void);
j3 3:644fc630f958 71
j3 23:e8e403d61359 72 virtual OneWireMaster::CmdResult OWReset(void);
j3 3:644fc630f958 73
IanBenzMaxim 72:6892702709ee 74 virtual OneWireMaster::CmdResult OWTouchBitSetLevel(uint8_t & sendrecvbit, OWLevel after_level);
j3 17:b646b1e3970b 75
IanBenzMaxim 72:6892702709ee 76 virtual OneWireMaster::CmdResult OWWriteByteSetLevel(uint8_t sendbyte, OWLevel after_level);
j3 3:644fc630f958 77
IanBenzMaxim 72:6892702709ee 78 virtual OneWireMaster::CmdResult OWReadByteSetLevel(uint8_t & recvbyte, OWLevel after_level);
j3 23:e8e403d61359 79
IanBenzMaxim 32:bce180b544ed 80 virtual OneWireMaster::CmdResult OWSetSpeed(OWSpeed new_speed);
j3 3:644fc630f958 81
IanBenzMaxim 32:bce180b544ed 82 virtual OneWireMaster::CmdResult OWSetLevel(OWLevel new_level);
IanBenzMaxim 26:a361e3f42ba5 83
IanBenzMaxim 26:a361e3f42ba5 84 private:
j3 3:644fc630f958 85
IanBenzMaxim 28:057bb14d3cee 86 const unsigned int _ow_port;
IanBenzMaxim 28:057bb14d3cee 87 const unsigned int _ow_pin;
IanBenzMaxim 28:057bb14d3cee 88
j3 5:ce108eeb878d 89 DigitalOut _ext_spu;
IanBenzMaxim 32:bce180b544ed 90 OWSpeed _ow_speed;
IanBenzMaxim 32:bce180b544ed 91 OWLevel _ow_level;
j3 9:641516a3f0dc 92
IanBenzMaxim 28:057bb14d3cee 93 inline void write_ow_gpio_low();
IanBenzMaxim 28:057bb14d3cee 94 inline void write_ow_gpio_high();
IanBenzMaxim 28:057bb14d3cee 95 inline bool read_ow_gpio();
IanBenzMaxim 28:057bb14d3cee 96 inline void set_ow_gpio_mode(unsigned int mode);
j3 3:644fc630f958 97 };
j3 3:644fc630f958 98
j3 10:0df2cc66fc47 99 #endif/* TARGET_MAX32600*/
j3 3:644fc630f958 100 #endif /*OWGPIO_H*/