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@15:f6cb0d906fb6, 2016-03-16 (annotated)

Committer:
j3
Date:
Wed Mar 16 01:19:45 2016 +0000
Revision:
15:f6cb0d906fb6
Parent:
14:7b2886a50321
Child:
17:b646b1e3970b
Removed duplicated code between masters by providing 'OneWireMaster' class that implements common parts of OneWireInterface.  OneWireMaster is now the class inherited by individual master implementations.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
j3 3:644fc630f958 1 /******************************************************************//**
j3 3:644fc630f958 2 * @file owgpio.h
j3 3:644fc630f958 3 *
j3 3:644fc630f958 4 * @author Justin Jordan
j3 3:644fc630f958 5 *
j3 3:644fc630f958 6 * @version 0.0.0
j3 3:644fc630f958 7 *
j3 3:644fc630f958 8 * Started: 31JAN16
j3 3:644fc630f958 9 *
j3 3:644fc630f958 10 * Updated:
j3 3:644fc630f958 11 *
j3 3:644fc630f958 12 * @brief Header file for bit-banging a 1-wire master
j3 3:644fc630f958 13 ***********************************************************************
j3 3:644fc630f958 14 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
j3 3:644fc630f958 15 *
j3 3:644fc630f958 16 * Permission is hereby granted, free of charge, to any person obtaining a
j3 3:644fc630f958 17 * copy of this software and associated documentation files (the "Software"),
j3 3:644fc630f958 18 * to deal in the Software without restriction, including without limitation
j3 3:644fc630f958 19 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
j3 3:644fc630f958 20 * and/or sell copies of the Software, and to permit persons to whom the
j3 3:644fc630f958 21 * Software is furnished to do so, subject to the following conditions:
j3 3:644fc630f958 22 *
j3 3:644fc630f958 23 * The above copyright notice and this permission notice shall be included
j3 3:644fc630f958 24 * in all copies or substantial portions of the Software.
j3 3:644fc630f958 25 *
j3 3:644fc630f958 26 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
j3 3:644fc630f958 27 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
j3 3:644fc630f958 28 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
j3 3:644fc630f958 29 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
j3 3:644fc630f958 30 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
j3 3:644fc630f958 31 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
j3 3:644fc630f958 32 * OTHER DEALINGS IN THE SOFTWARE.
j3 3:644fc630f958 33 *
j3 3:644fc630f958 34 * Except as contained in this notice, the name of Maxim Integrated
j3 3:644fc630f958 35 * Products, Inc. shall not be used except as stated in the Maxim Integrated
j3 3:644fc630f958 36 * Products, Inc. Branding Policy.
j3 3:644fc630f958 37 *
j3 3:644fc630f958 38 * The mere transfer of this software does not imply any licenses
j3 3:644fc630f958 39 * of trade secrets, proprietary technology, copyrights, patents,
j3 3:644fc630f958 40 * trademarks, maskwork rights, or any other form of intellectual
j3 3:644fc630f958 41 * property whatsoever. Maxim Integrated Products, Inc. retains all
j3 3:644fc630f958 42 * ownership rights.
j3 3:644fc630f958 43 **********************************************************************/
j3 3:644fc630f958 44
j3 3:644fc630f958 45
j3 3:644fc630f958 46 #ifndef OWGPIO_H
j3 3:644fc630f958 47 #define OWGPIO_H
j3 3:644fc630f958 48
j3 3:644fc630f958 49
j3 10:0df2cc66fc47 50 #if(TARGET_MAX32600)
j3 10:0df2cc66fc47 51
j3 10:0df2cc66fc47 52
j3 3:644fc630f958 53 #include "mbed.h"
j3 3:644fc630f958 54 #include "OneWireInterface.h"
j3 15:f6cb0d906fb6 55 #include "OneWireMaster.h"
j3 3:644fc630f958 56
j3 3:644fc630f958 57
j3 15:f6cb0d906fb6 58 class OwGpio: public OneWireMaster
j3 3:644fc630f958 59 {
j3 3:644fc630f958 60 public:
j3 3:644fc630f958 61
j3 10:0df2cc66fc47 62 //1-wire timming constants for bit-bang.
j3 10:0df2cc66fc47 63 //Bit-Bang Master only supported on MAX32600MBED board
j3 10:0df2cc66fc47 64 //All times are in terms of micro seconds
j3 9:641516a3f0dc 65
j3 10:0df2cc66fc47 66 static const uint16_t TRSTL_STD = 560;
j3 10:0df2cc66fc47 67 static const uint16_t TRSTL_OVD = 56;
j3 9:641516a3f0dc 68
j3 9:641516a3f0dc 69 //Master sample time for PD
j3 10:0df2cc66fc47 70 static const uint16_t TMSP_STD = 68;
j3 10:0df2cc66fc47 71 static const uint16_t TMSP_OVD = 8;
j3 9:641516a3f0dc 72
j3 9:641516a3f0dc 73 //Write 0
j3 10:0df2cc66fc47 74 static const uint16_t TW0L_STD = 64;
j3 10:0df2cc66fc47 75 static const uint16_t TW0L_OVD = 8;
j3 9:641516a3f0dc 76
j3 9:641516a3f0dc 77 //Write 1, Read low time
j3 10:0df2cc66fc47 78 static const uint16_t TW1L_STD = 8;
j3 11:2833f27ba319 79 static const uint16_t TW1L_OVD = 0; //closest to 1us I can get
j3 9:641516a3f0dc 80
j3 9:641516a3f0dc 81 //Master sample time for bit
j3 10:0df2cc66fc47 82 static const uint16_t TMSR_STD = 12;
j3 11:2833f27ba319 83 static const uint16_t TMSR_OVD = 0; //closest to 1us I can get
j3 9:641516a3f0dc 84
j3 10:0df2cc66fc47 85 //make sure to use TSLOT for recoveries
j3 10:0df2cc66fc47 86 static const uint16_t TSLOT_STD = 70;
j3 10:0df2cc66fc47 87 static const uint16_t TSLOT_OVD = 10;
j3 9:641516a3f0dc 88
j3 9:641516a3f0dc 89
j3 14:7b2886a50321 90 //counts instances of this class being created
j3 14:7b2886a50321 91 static uint32_t ow_instance_cnt;
j3 14:7b2886a50321 92
j3 14:7b2886a50321 93
j3 3:644fc630f958 94 /**********************************************************//**
j3 10:0df2cc66fc47 95 * @brief Owgpio constructor
j3 10:0df2cc66fc47 96 *
j3 10:0df2cc66fc47 97 * @details Initializes given pin for open-drain operation
j3 10:0df2cc66fc47 98 *
j3 10:0df2cc66fc47 99 * On Entry:
j3 10:0df2cc66fc47 100 *
j3 10:0df2cc66fc47 101 * @para[in] ow_gpio - GPIO pin to use for One Wire bus
j3 10:0df2cc66fc47 102 *
j3 10:0df2cc66fc47 103 * @param[in] ext_spu - GPIO pin to use for Strong Pull-Up
j3 10:0df2cc66fc47 104 *
j3 10:0df2cc66fc47 105 * On Exit:
j3 10:0df2cc66fc47 106 *
j3 10:0df2cc66fc47 107 * @return
j3 10:0df2cc66fc47 108 **************************************************************/
j3 10:0df2cc66fc47 109 OwGpio(PinName ow_gpio, PinName ext_spu = NC);
j3 10:0df2cc66fc47 110
j3 10:0df2cc66fc47 111
j3 10:0df2cc66fc47 112 /**********************************************************//**
j3 10:0df2cc66fc47 113 * @brief OwGpio destructor
j3 10:0df2cc66fc47 114 *
j3 10:0df2cc66fc47 115 * @details
j3 10:0df2cc66fc47 116 *
j3 10:0df2cc66fc47 117 * On Entry:
j3 10:0df2cc66fc47 118 *
j3 10:0df2cc66fc47 119 * On Exit:
j3 10:0df2cc66fc47 120 *
j3 10:0df2cc66fc47 121 * @return
j3 10:0df2cc66fc47 122 **************************************************************/
j3 10:0df2cc66fc47 123 virtual ~OwGpio();
j3 10:0df2cc66fc47 124
j3 10:0df2cc66fc47 125
j3 15:f6cb0d906fb6 126 //Part of OneWireInterface that should be implemented for each master
j3 15:f6cb0d906fb6 127 //See OneWireInterface.h for documentation
j3 15:f6cb0d906fb6 128
j3 14:7b2886a50321 129 virtual bool OWInitMaster();
j3 3:644fc630f958 130
j3 3:644fc630f958 131 virtual bool OWReset();
j3 3:644fc630f958 132
j3 3:644fc630f958 133 virtual uint8_t OWTouchBit(uint8_t sendbit);
j3 3:644fc630f958 134
j3 3:644fc630f958 135 virtual bool OWWriteByte(uint8_t sendbyte);
j3 3:644fc630f958 136
j3 3:644fc630f958 137 virtual uint8_t OWReadByte(void);
j3 3:644fc630f958 138
j3 3:644fc630f958 139 virtual bool OWSearch(void);
j3 3:644fc630f958 140
j3 5:ce108eeb878d 141 virtual uint8_t OWSpeed(OW_SPEED new_speed);
j3 3:644fc630f958 142
j3 5:ce108eeb878d 143 virtual uint8_t OWLevel(OW_LEVEL new_level);
j3 3:644fc630f958 144
j3 3:644fc630f958 145 virtual bool OWWriteBytePower(uint8_t sendbyte);
j3 3:644fc630f958 146
j3 3:644fc630f958 147 virtual bool OWReadBitPower(uint8_t applyPowerResponse);
j3 3:644fc630f958 148
j3 3:644fc630f958 149 private:
j3 3:644fc630f958 150
j3 14:7b2886a50321 151 static void init_ow_timer(void);
j3 14:7b2886a50321 152 static void release_ow_timer(void);
j3 14:7b2886a50321 153
j3 14:7b2886a50321 154 void init_ow_gpio(uint32_t ow_port, uint32_t ow_pin);
j3 14:7b2886a50321 155 void release_ow_gpio();
j3 14:7b2886a50321 156
j3 14:7b2886a50321 157 //specific instance of this class
j3 14:7b2886a50321 158 uint32_t _ow_instance;
j3 10:0df2cc66fc47 159
j3 5:ce108eeb878d 160 DigitalOut _ext_spu;
j3 9:641516a3f0dc 161 OW_SPEED _ow_speed;
j3 9:641516a3f0dc 162 OW_LEVEL _ow_level;
j3 9:641516a3f0dc 163
j3 10:0df2cc66fc47 164 uint32_t _ow_port;
j3 15:f6cb0d906fb6 165 uint32_t _ow_pin;
j3 3:644fc630f958 166 };
j3 3:644fc630f958 167
j3 10:0df2cc66fc47 168 #endif/* TARGET_MAX32600*/
j3 3:644fc630f958 169 #endif /*OWGPIO_H*/