Ted Grosch / Mbed OS Nucleo_TOF_I2C_OS5

New Version with OS5

register.cpp@3:0eb6a9927171, 2020-10-25 (annotated)

Committer:
tgrosch
Date:
Sun Oct 25 10:45:04 2020 +0000
Revision:
3:0eb6a9927171
Parent:
0:62b846b3988a 
New version with OS5

Who changed what in which revision?

UserRevisionLine numberNew contents of line
tgrosch 0:62b846b3988a 1 /*
tgrosch 0:62b846b3988a 2 * \file register.cpp
tgrosch 0:62b846b3988a 3 * \author Karthik Rajagopal <krthik@ti.com>
tgrosch 0:62b846b3988a 4 * \version 0.9.1
tgrosch 0:62b846b3988a 5 *
tgrosch 0:62b846b3988a 6 * \section COPYRIGHT
tgrosch 0:62b846b3988a 7 * TEXAS INSTRUMENTS TEXT FILE LICENSE
tgrosch 0:62b846b3988a 8 * Copyright (c) 2018 Texas Instruments Incorporated
tgrosch 0:62b846b3988a 9 * All rights reserved not granted herein.
tgrosch 0:62b846b3988a 10 * Limited License.
tgrosch 0:62b846b3988a 11 * Texas Instruments Incorporated grants a world-wide, royalty-free, non-exclusive license under copyrights and patents it now or hereafter owns or controls to make, have made, use, import, offer to sell and sell ("Utilize") this software subject to the terms herein. With respect to the foregoing patent license, such license is granted solely to the extent that any such patent is necessary to Utilize the software alone. The patent license shall not apply to any combinations which include this software, other than combinations with devices manufactured by or for TI ("TI Devices"). No hardware patent is licensed hereunder.
tgrosch 0:62b846b3988a 12 * Redistributions must preserve existing copyright notices and reproduce this license (including the above copyright notice and the disclaimer and (if applicable) source code license limitations below) in the documentation and/or other materials provided with the distribution
tgrosch 0:62b846b3988a 13 * Redistribution and use in binary form, without modification, are permitted provided that the following conditions are met:
tgrosch 0:62b846b3988a 14 * * No reverse engineering, decompilation, or disassembly of this software is permitted with respect to any software provided in binary form.
tgrosch 0:62b846b3988a 15 * * any redistribution and use are licensed by TI for use only with TI Devices.
tgrosch 0:62b846b3988a 16 * * Nothing shall obligate TI to provide you with source code for the software licensed and provided to you in object code.
tgrosch 0:62b846b3988a 17 * If software source code is provided to you, modification and redistribution of the source code are permitted provided that the following conditions are met:
tgrosch 0:62b846b3988a 18 * * any redistribution and use of the source code, including any resulting derivative works, are licensed by TI for use only with TI Devices.
tgrosch 0:62b846b3988a 19 * * any redistribution and use of any object code compiled from the source code and any resulting derivative works, are licensed by TI for use only with TI Devices.
tgrosch 0:62b846b3988a 20 * Neither the name of Texas Instruments Incorporated nor the names of its suppliers may be used to endorse or promote products derived from this software without specific prior written permission.
tgrosch 0:62b846b3988a 21 * DISCLAIMER.
tgrosch 0:62b846b3988a 22 * THIS SOFTWARE IS PROVIDED BY TI AND TI'S LICENSORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL TI AND TI'S LICENSORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
tgrosch 0:62b846b3988a 23 *
tgrosch 0:62b846b3988a 24 * \section DESCRIPTION
tgrosch 0:62b846b3988a 25 * The file contains class descriptions and methods for register control for OPT3101 device
tgrosch 0:62b846b3988a 26 */
tgrosch 0:62b846b3988a 27
tgrosch 0:62b846b3988a 28
tgrosch 0:62b846b3988a 29 #include "register.h"
tgrosch 0:62b846b3988a 30
tgrosch 0:62b846b3988a 31 /** \brief hostController declaration
tgrosch 0:62b846b3988a 32 This global variable declaration with name host of hostController is used by various methods to send specific control commands to the host
tgrosch 0:62b846b3988a 33 */
tgrosch 0:62b846b3988a 34
tgrosch 0:62b846b3988a 35 OPT3101::deviceRegister::deviceRegister(uint8_t size){
tgrosch 0:62b846b3988a 36 /// <b>Algorithm of the method is as follows</b>
tgrosch 0:62b846b3988a 37 this->size=size; /// * Assigns size from input argument to the class member OPT3101::deviceRegister::size
tgrosch 0:62b846b3988a 38 }
tgrosch 0:62b846b3988a 39 void OPT3101::deviceRegister::write(int32_t value){
tgrosch 0:62b846b3988a 40 uint8_t i;
tgrosch 0:62b846b3988a 41 uint32_t mask;
tgrosch 0:62b846b3988a 42 uint32_t readValue;
tgrosch 0:62b846b3988a 43 uint32_t writeValue;
tgrosch 0:62b846b3988a 44 uint32_t regmask;
tgrosch 0:62b846b3988a 45 uint8_t size;
tgrosch 0:62b846b3988a 46 /// <b>Algorithm of the method is as follows</b>
tgrosch 0:62b846b3988a 47 value=(uint32_t) value; /// * Converts the input value to uint32_t
tgrosch 0:62b846b3988a 48 for(i=0;i<this->size;i++){ /// * Loops though the number of OPT3101::deviceRegister::address fields based on OPT3101::deviceRegister::size
tgrosch 0:62b846b3988a 49 readValue=this->read(i); /// * Invokes hostController::readI2C() method to get register value from h/w
tgrosch 0:62b846b3988a 50 size=this->msb[i]+1-this->lsb[i];
tgrosch 0:62b846b3988a 51 mask=~(((uint32_t) -1)<<(size));
tgrosch 0:62b846b3988a 52 writeValue=value&mask;
tgrosch 0:62b846b3988a 53 value=value>>size;
tgrosch 0:62b846b3988a 54 regmask=(~((((uint32_t) -1)<<(this->msb[i]+1))^(((uint32_t) -1)<<this->lsb[i])))&0xFFFFFF; /// * Masks the bits for the new value to be written
tgrosch 0:62b846b3988a 55 writeValue=(writeValue<<this->lsb[i])|(readValue&regmask);/// * Creates a new register value to be written to h/w based on created mask and data to be written
tgrosch 0:62b846b3988a 56 if(readValue!=writeValue)
tgrosch 0:62b846b3988a 57 this->writeI2C(this->address[i],writeValue); /// * Initiates hostController::writeI2C function with address and new register value
tgrosch 0:62b846b3988a 58 }
tgrosch 0:62b846b3988a 59 }
tgrosch 0:62b846b3988a 60
tgrosch 0:62b846b3988a 61 void OPT3101::deviceRegister::operator=(int32_t value){
tgrosch 0:62b846b3988a 62 this->write(value);
tgrosch 0:62b846b3988a 63 }
tgrosch 0:62b846b3988a 64
tgrosch 0:62b846b3988a 65 uint32_t OPT3101::deviceRegister::read(){
tgrosch 0:62b846b3988a 66 int8_t i;
tgrosch 0:62b846b3988a 67 uint32_t readValue;
tgrosch 0:62b846b3988a 68 uint32_t regmask;
tgrosch 0:62b846b3988a 69 uint8_t size;
tgrosch 0:62b846b3988a 70 uint8_t bitPos;
tgrosch 0:62b846b3988a 71 uint32_t returnValue;
tgrosch 0:62b846b3988a 72
tgrosch 0:62b846b3988a 73 returnValue=0;
tgrosch 0:62b846b3988a 74 bitPos=0;
tgrosch 0:62b846b3988a 75 /// <b>Algorithm of the method is as follows</b>
tgrosch 0:62b846b3988a 76 for(i=0;i<this->size;i++){ /// * Loops though the number of OPT3101::deviceRegister::address fields based on OPT3101::deviceRegister::size
tgrosch 0:62b846b3988a 77 readValue=this->read(i); /// * Invokes hostController::readI2C() method to get register value from h/w
tgrosch 0:62b846b3988a 78 size=this->msb[i]+1-this->lsb[i];
tgrosch 0:62b846b3988a 79 regmask=(((((uint32_t) -1)<<(this->msb[i]+1))^(((uint32_t) -1)<<this->lsb[i])))&0xFFFFFF; /// * Masks the bits for the register value to be reported based on register positional information
tgrosch 0:62b846b3988a 80 //printf("Read mask for register 0x%02x is 0x%08x\n",this->address[i],regmask);
tgrosch 0:62b846b3988a 81 returnValue|=((readValue&regmask)>>this->lsb[i])<<bitPos; /// * Assembles the value of the register
tgrosch 0:62b846b3988a 82 bitPos+=size;
tgrosch 0:62b846b3988a 83 }
tgrosch 0:62b846b3988a 84 //printf("Resolved Value is %d",returnValue);
tgrosch 0:62b846b3988a 85 return returnValue; /// * Returns the value read from the h/w for the register name specified
tgrosch 0:62b846b3988a 86 }
tgrosch 0:62b846b3988a 87
tgrosch 0:62b846b3988a 88 uint32_t OPT3101::deviceRegister::read(uint8_t index){
tgrosch 0:62b846b3988a 89 /// <b>Algorithm of the method is as follows</b>
tgrosch 0:62b846b3988a 90 return this->readI2C(this->address[index]); /// * Returns the value read from the h/w for the register name specified
tgrosch 0:62b846b3988a 91 }
tgrosch 0:62b846b3988a 92
tgrosch 0:62b846b3988a 93 uint32_t OPT3101::deviceRegister::readI2C(uint8_t address){
tgrosch 0:62b846b3988a 94 /// <b>Algorithm of the method is as follows</b>
tgrosch 0:62b846b3988a 95 return host.readI2C(address); /// * Invokes hostController::readI2C and returns the value read from the h/w d
tgrosch 0:62b846b3988a 96 }
tgrosch 0:62b846b3988a 97
tgrosch 0:62b846b3988a 98 void OPT3101::deviceRegister::writeI2C(uint8_t address,uint32_t data){
tgrosch 0:62b846b3988a 99 /// <b>Algorithm of the method is as follows</b>
tgrosch 0:62b846b3988a 100 host.writeI2C(address, data); /// * Invokes hostController::writeI2C with address and data specified as arguments
tgrosch 0:62b846b3988a 101 }
tgrosch 0:62b846b3988a 102
tgrosch 0:62b846b3988a 103
tgrosch 0:62b846b3988a 104 OPT3101::deviceRegister2::deviceRegister2(uint8_t size){
tgrosch 0:62b846b3988a 105 /// <b>Algorithm of the method is as follows</b>
tgrosch 0:62b846b3988a 106 this->size=size; /// * Assigns size from input argument to the class member OPT3101::deviceRegister::size
tgrosch 0:62b846b3988a 107 }
tgrosch 0:62b846b3988a 108 void OPT3101::deviceRegister2::write(int32_t value){
tgrosch 0:62b846b3988a 109 uint8_t i;
tgrosch 0:62b846b3988a 110 uint32_t mask;
tgrosch 0:62b846b3988a 111 uint32_t readValue;
tgrosch 0:62b846b3988a 112 uint32_t writeValue;
tgrosch 0:62b846b3988a 113 uint32_t regmask;
tgrosch 0:62b846b3988a 114 uint8_t size;
tgrosch 0:62b846b3988a 115 /// <b>Algorithm of the method is as follows</b>
tgrosch 0:62b846b3988a 116 value=(uint32_t) value; /// * Converts the input value to uint32_t
tgrosch 0:62b846b3988a 117 for(i=0;i<this->size;i++){ /// * Loops though the number of OPT3101::deviceRegister::address fields based on OPT3101::deviceRegister::size
tgrosch 0:62b846b3988a 118 readValue=this->read(i); /// * Invokes hostController::readI2C() method to get register value from h/w
tgrosch 0:62b846b3988a 119 size=this->msb[i]+1-this->lsb[i];
tgrosch 0:62b846b3988a 120 mask=~(((uint32_t) -1)<<(size));
tgrosch 0:62b846b3988a 121 writeValue=value&mask;
tgrosch 0:62b846b3988a 122 value=value>>size;
tgrosch 0:62b846b3988a 123 regmask=(~((((uint32_t) -1)<<(this->msb[i]+1))^(((uint32_t) -1)<<this->lsb[i])))&0xFFFFFF; /// * Masks the bits for the new value to be written
tgrosch 0:62b846b3988a 124 writeValue=(writeValue<<this->lsb[i])|(readValue&regmask);/// * Creates a new register value to be written to h/w based on created mask and data to be written
tgrosch 0:62b846b3988a 125 if(readValue!=writeValue)
tgrosch 0:62b846b3988a 126 this->writeI2C(this->address[i],writeValue); /// * Initiates hostController::writeI2C function with address and new register value
tgrosch 0:62b846b3988a 127 }
tgrosch 0:62b846b3988a 128 }
tgrosch 0:62b846b3988a 129
tgrosch 0:62b846b3988a 130 void OPT3101::deviceRegister2::operator=(int32_t value){
tgrosch 0:62b846b3988a 131 this->write(value);
tgrosch 0:62b846b3988a 132 }
tgrosch 0:62b846b3988a 133
tgrosch 0:62b846b3988a 134 uint32_t OPT3101::deviceRegister2::read(){
tgrosch 0:62b846b3988a 135 uint8_t i;
tgrosch 0:62b846b3988a 136 uint32_t readValue;
tgrosch 0:62b846b3988a 137 uint32_t regmask;
tgrosch 0:62b846b3988a 138 uint8_t size;
tgrosch 0:62b846b3988a 139 uint8_t bitPos;
tgrosch 0:62b846b3988a 140 uint32_t returnValue;
tgrosch 0:62b846b3988a 141
tgrosch 0:62b846b3988a 142 returnValue=0;
tgrosch 0:62b846b3988a 143 bitPos=0;
tgrosch 0:62b846b3988a 144 /// <b>Algorithm of the method is as follows</b>
tgrosch 0:62b846b3988a 145 for(i=0;i<this->size;i++){ /// * Loops though the number of OPT3101::deviceRegister::address fields based on OPT3101::deviceRegister::size
tgrosch 0:62b846b3988a 146 readValue=this->read(i); /// * Invokes hostController::readI2C() method to get register value from h/w
tgrosch 0:62b846b3988a 147 size=this->msb[i]+1-this->lsb[i];
tgrosch 0:62b846b3988a 148 regmask=(((((uint32_t) -1)<<(this->msb[i]+1))^(((uint32_t) -1)<<this->lsb[i])))&0xFFFFFF; /// * Masks the bits for the register value to be reported based on register positional information
tgrosch 0:62b846b3988a 149 //printf("Read mask for register 0x%02x is 0x%08x\n",this->address[i],regmask);
tgrosch 0:62b846b3988a 150 returnValue|=((readValue&regmask)>>this->lsb[i])<<bitPos; /// * Assembles the value of the register
tgrosch 0:62b846b3988a 151 bitPos+=size;
tgrosch 0:62b846b3988a 152 }
tgrosch 0:62b846b3988a 153 //printf("Resolved Value is %d",returnValue);
tgrosch 0:62b846b3988a 154 return returnValue; /// * Returns the value read from the h/w for the register name specified
tgrosch 0:62b846b3988a 155 }
tgrosch 0:62b846b3988a 156
tgrosch 0:62b846b3988a 157 uint32_t OPT3101::deviceRegister2::read(uint8_t index){
tgrosch 0:62b846b3988a 158 /// <b>Algorithm of the method is as follows</b>
tgrosch 0:62b846b3988a 159 return this->readI2C(this->address[index]); /// * Returns the value read from the h/w for the register name specified
tgrosch 0:62b846b3988a 160 }
tgrosch 0:62b846b3988a 161
tgrosch 0:62b846b3988a 162 uint32_t OPT3101::deviceRegister2::readI2C(uint8_t address){
tgrosch 0:62b846b3988a 163 /// <b>Algorithm of the method is as follows</b>
tgrosch 0:62b846b3988a 164 return host.readI2C(address); /// * Invokes hostController::readI2C and returns the value read from the h/w d
tgrosch 0:62b846b3988a 165 }
tgrosch 0:62b846b3988a 166
tgrosch 0:62b846b3988a 167 void OPT3101::deviceRegister2::writeI2C(uint8_t address,uint32_t data){
tgrosch 0:62b846b3988a 168 /// <b>Algorithm of the method is as follows</b>
tgrosch 0:62b846b3988a 169 host.writeI2C(address, data); /// * Invokes hostController::writeI2C with address and data specified as arguments
tgrosch 0:62b846b3988a 170 }
tgrosch 0:62b846b3988a 171
tgrosch 0:62b846b3988a 172 //printf("Dummy I2C read from OPT3101 register addr:0x%02x data:0x%06x\n",address,i2cReadValue);
tgrosch 0:62b846b3988a 173 //printf("Dummy I2C write to OPT3101 register addr:0x%02x data:0x%06x\n",address,data);
tgrosch 0:62b846b3988a 174