Revision 8:dea50f607a45, committed 2016-09-29

Comitter:

MikkoZ

Date:

Thu Sep 29 15:10:08 2016 +0000

Parent:

7:f83fa2f3cfab

Child:

9:51c7b97b6a7d

Commit message:

Initial version of C++ RegisterWriter. Code ported from 'C'-library rohm-sensor-hal.

Changed in this revision

--- a/README.md	Tue Apr 12 12:55:24 2016 +0000
+++ b/README.md	Thu Sep 29 15:10:08 2016 +0000
@@ -1,2 +1,2 @@
-# rohm-sensor-hal
-Platform HAL for rohm sensor drivers. Used for abstracting Arduino/mbed os/mbed classic.
+# RegisterWriter
+Platform HAL for i2c drivers. Used for abstracting Arduino/mbed os/mbed classic.

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/RegisterWriter/RegisterWriter.h	Thu Sep 29 15:10:08 2016 +0000
@@ -0,0 +1,62 @@
+/*   Copyright 2016 Rohm Semiconductor
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+#ifndef i2c_common_pp_h
+#define i2c_common_pp_h
+
+#include "rohm_hal2.h"       //types, DEBUG_print*, USE_*_HARDWARE_I2C
+
+class RegisterWriter
+{
+public:
+    /**
+    * Use pre-instantiated I2C instance for hal.
+    *
+    * @param i2c_obj pre-instantiated i2c object.
+    */
+    RegisterWriter(I2C &i2c_obj);
+
+    /**
+    * Create a i2c instance which is connected to specified I2C pins.
+    *
+    * @param sda SDA pin
+    * @param sdl SCL pin
+    */
+    RegisterWriter(PinName sda = I2C_SDA, PinName scl = I2C_SCL);
+
+    /**
+    * RegisterWriter destructor
+    */
+    ~RegisterWriter();
+
+    /**
+    * read/write commands for sensor registers
+    */
+    uint8_t read_register(uint8_t sad, uint8_t reg, uint8_t* buf, uint8_t buf_len);
+    uint8_t read_fifo_register(uint8_t sad, uint8_t reg, uint8_t* buf, uint8_t buf_len);
+    void write_register(uint8_t sad, uint8_t reg, uint8_t* data, uint8_t data_len);
+    void write_register(uint8_t sad, uint8_t reg, uint8_t data);
+    bool change_bits(uint8_t sad, uint8_t reg, uint8_t mask, uint8_t bits);
+
+private:
+    I2C i2c_bus;
+    bool self_created_i2c;
+};
+
+
+
+
+#endif
+
+

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/RegisterWriter/rohm_hal2.h	Thu Sep 29 15:10:08 2016 +0000
@@ -0,0 +1,38 @@
+/*   Copyright 2016 Rohm Semiconductor
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+#ifndef ROHM_HAL_H
+#define ROHM_HAL_H
+
+/* This file is meant for making same code work on many platforms easier. */
+#ifdef __MBED__
+    /* Mbed Classic */
+    #include "mbed.h"               //types
+    #include "I2C.h"                //I2C
+
+    #define USE_MBED_HARDWARE_I2C
+    extern Serial pc;
+    //Serial pc(USBTX, USBRX); done in main.cpp
+    #define DEBUG_print(...)    pc.printf(__VA_ARGS__)
+    #define DEBUG_printf(...)   pc.printf(__VA_ARGS__)
+    #define DEBUG_println(...)  pc.printf(__VA_ARGS__);pc.printf("\r\n")
+#endif
+
+#if 0       //Enable/disable debug prints
+    #define DEBUG_print()
+    #define DEBUG_printf()
+    #define DEBUG_println()
+#endif
+
+#endif /* ROHM_HAL_H */

--- a/module.json	Tue Apr 12 12:55:24 2016 +0000
+++ b/module.json	Thu Sep 29 15:10:08 2016 +0000
@@ -1,15 +1,15 @@
 {
-  "name": "rohm-sensor-hal",
+  "name": "RegisterWriter",
   "version": "0.1.0",
   "license": "Apache-2.0",
-  "description": "Rohm HAL for sensor driver development",
+  "description": "Rohm HAL cpp for sensor driver development",
   "keywords": [
     "rohm",
     "hal"
   ],
   "author": "Mikko Koivunen",
   "repository": {
-    "url": "https://github.com/MikkoZ-Rohm/rohm-sensor-hal1.git",
+    "url": "https://github.com/MikkoZ-Rohm/RegisterWriter.git",
     "type": "git"
   },
   "dependencies": {

--- a/rohm-sensor-hal/I2CCommon.h	Tue Apr 12 12:55:24 2016 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,32 +0,0 @@
-/*   Copyright 2016 Rohm Semiconductor
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
-*/
-#ifndef i2c_common_h
-#define i2c_common_h
-/*  i2c common functions 
-    This interface is the same for Arduino hardware i2c lib Wire, Arduino software i2c lib SoftI2CMaster and mbed hardware lib I2C.
-    Choosing between them is done by compile time using flags, for mbed use USE_MBED_HARDWARE_I2C -flag.
-    Note: This method doesn't allow multiple i2c busses to be used at same time.
-*/
-#include "rohm_hal.h"       //types, DEBUG_print*, USE_*_HARDWARE_I2C
-
-bool I2CCommonBegin();
-uint8_t read_register(uint8_t sad, uint8_t reg, uint8_t* buf, uint8_t buf_len);
-void write_registers(uint8_t sad, uint8_t reg, uint8_t* data, uint8_t data_len);
-void write_register(uint8_t sad, uint8_t reg, uint8_t data);
-bool change_bits(uint8_t sad, uint8_t reg, uint8_t mask, uint8_t bits);
-
-#endif
-
-

--- a/rohm-sensor-hal/rohm_hal.h	Tue Apr 12 12:55:24 2016 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,65 +0,0 @@
-/*   Copyright 2016 Rohm Semiconductor
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
-*/
-#ifndef ROHM_HAL_H
-#define ROHM_HAL_H
-
-/* This file is meant for making same code work on many platforms easier. */
-#ifdef __MBED__
-    /* Mbed Classic */
-    #include "mbed.h"               //types
-    #include "I2C.h"                //I2C
-
-    #define USE_MBED_HARDWARE_I2C
-    extern Serial pc;
-    //Serial pc(USBTX, USBRX); done in main.cpp
-    #define DEBUG_print(...)    pc.printf(__VA_ARGS__)
-    #define DEBUG_printf(...)   pc.printf(__VA_ARGS__)
-    #define DEBUG_println(...)  pc.printf(__VA_ARGS__);pc.printf("\r\n")
-#elif defined(YOTTA_MODULE_NAME)
-    /* Mbed OS */
-    #include "mbed-drivers/mbed.h"  //types, Serial, I2C -type, ...
-    #include "mbed-drivers/I2C.h"   //I2C
-
-    #define USE_MBED_HARDWARE_I2C
-    //get_stdio_serial().baud(115200); done in main.cpp
-
-    #define DEBUG_print(...)    printf(__VA_ARGS__)
-    #define DEBUG_printf(...)   printf(__VA_ARGS__)
-    #define DEBUG_println(...)  printf(__VA_ARGS__);printf("\r\n")
-
-#elif __ARDUINO__
-    /* Arduino */
-    #include <arduino.h>            //types, Serial
-
-    //#define USE_ARDUINO_SOFTWARE_I2C
-    #define USE_ARDUINO_HARDWARE_I2C
-
-    #define DEBUG_printf(a)         Serial.print(a)
-    #define DEBUG_printf(a, b)      Serial.print(a);Serial.print(b)
-    #define DEBUG_printf(a, b, c)       Serial.print(a);Serial.print(b);Serial.print(c)
-    #define DEBUG_printf(a, b, c, ...)  Serial.print(a);Serial.print(b);Serial.print(c)
-    #define DEBUG_print()           Serial.print()
-    #define DEBUG_println()         Serial.println()
-#else
-    #error "rohm_hal.h: Not valid target."
-#endif
-
-#if 0       //Enable/disable debug prints
-    #define DEBUG_print()
-    #define DEBUG_printf()
-    #define DEBUG_println()
-#endif
-
-#endif /* ROHM_HAL_H */

--- a/source/I2CCommonMbedHardwareLib.cpp	Tue Apr 12 12:55:24 2016 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,75 +0,0 @@
-/*   Copyright 2016 Rohm Semiconductor
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
-*/
-#include "../rohm-sensor-hal/rohm_hal.h"           //types, USE_MBED_HARDWARE_I2C, DEBUG_print*, I2C.h, I2C_SDA, I2C_SCL
-#ifdef USE_MBED_HARDWARE_I2C
-#include "../rohm-sensor-hal/I2CCommon.h"          //prototypes
-#define I2C_WRITE 0
-#define I2C_READ  1
-I2C i2c(I2C_SDA, I2C_SCL);
-
-
-//Note that I2CCommonBegin() must be called before using read/write functions.
-bool I2CCommonBegin(){
-    return( true );        //always succeeds
-}
-
-/* i2c common functions */
-uint8_t read_register(uint8_t sad, uint8_t reg, uint8_t* buf, uint8_t buf_len) {
-    uint8_t received_bytes;
-    int read_ok;
-
-    i2c.write( (int)((sad << 1) | I2C_WRITE), (char*)&reg, (int)1 );
-    read_ok = i2c.read( (int)((sad << 1) | I2C_READ), (char*)buf, (int)buf_len);
-
-    if( read_ok == 0 ){     //0 == success(ack)
-        received_bytes = buf_len;
-        }
-    else{                   //non0 == fail (nack)
-        received_bytes = 0;
-        }
-    return( received_bytes );
-}
-
-void write_registers(uint8_t sad, uint8_t reg, uint8_t* data, uint8_t data_len) {
-    i2c.write( (int)((sad << 1) | I2C_WRITE ), (char*)&reg, (int)1, true);
-    i2c.write( (int)((sad << 1) | I2C_WRITE ), (char*)data, (int)data_len, false);
-}
-
-void write_register(uint8_t sad, uint8_t reg, uint8_t data) {
-    char data_to_send[2];
-
-    data_to_send[0] = reg;
-    data_to_send[1] = data;
-    i2c.write( (int)((sad << 1) | I2C_WRITE ), &data_to_send[0], 2);
-}
-
-bool change_bits(uint8_t sad, uint8_t reg, uint8_t mask, uint8_t bits){
-    uint8_t value, read_bytes;
-    read_bytes = read_register(sad, reg, &value, 1);
-    if( read_bytes != 0 ){
-        value = value & ~mask;
-        value = value | (bits & mask);
-        write_register(sad, reg, value);
-        return true;
-        }
-    else{
-        //DEBUG_printf("Read before change_bits() failed.");
-        return false;
-        }
-}
-
-#endif
-
-

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/source/RegisterWriter.cpp	Thu Sep 29 15:10:08 2016 +0000
@@ -0,0 +1,101 @@
+/*   Copyright 2016 Rohm Semiconductor
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+#include "../RegisterWriter/rohm_hal2.h"           //types, USE_MBED_HARDWARE_I2C, DEBUG_print*, I2C.h, I2C_SDA, I2C_SCL
+
+#ifdef USE_MBED_HARDWARE_I2C
+#include "../RegisterWriter/RegisterWriter.h"          //prototypes
+#define I2C_WRITE 0
+#define I2C_READ  1
+
+
+RegisterWriter::RegisterWriter(I2C &i2c_obj) : i2c_bus(i2c_obj) {
+    self_created_i2c = false;
+}
+
+RegisterWriter::RegisterWriter(PinName sda, PinName scl) : i2c_bus(sda, scl) {
+    self_created_i2c = true;
+}
+
+RegisterWriter::~RegisterWriter(){
+    if (self_created_i2c == true){
+        delete &i2c_bus;
+        }
+}
+
+/* i2c common functions */
+uint8_t RegisterWriter::read_register(uint8_t sad, uint8_t reg, uint8_t* buf, uint8_t buf_len) {
+    uint8_t received_bytes;
+    int read_ok;
+
+    i2c_bus.write( (int)((sad << 1) | I2C_WRITE), (char*)&reg, (int)1 );
+    read_ok = i2c_bus.read( (int)((sad << 1) | I2C_READ), (char*)buf, (int)buf_len);
+
+    if( read_ok == 0 ){     //0 == success(ack)
+        received_bytes = buf_len;
+        }
+    else{                   //non0 == fail (nack)
+        received_bytes = 0;
+        }
+    return( received_bytes );
+}
+
+uint8_t RegisterWriter::read_fifo_register(uint8_t sad, uint8_t reg, uint8_t* buf, uint8_t buf_len) {
+    uint8_t received_bytes;
+    int read_ok;
+
+    i2c_bus.write( (int)((sad << 1) | I2C_WRITE), (char*)&reg, (int)0 );
+    read_ok = i2c_bus.read( (int)((sad << 1) | I2C_READ), (char*)buf, (int)buf_len);
+
+    if( read_ok == 0 ){     //0 == success(ack)
+        received_bytes = buf_len;
+        }
+    else{                   //non0 == fail (nack)
+        received_bytes = 0;
+        }
+    return( received_bytes );
+}
+
+void RegisterWriter::write_register(uint8_t sad, uint8_t reg, uint8_t* data, uint8_t data_len) {
+    i2c_bus.write( (int)((sad << 1) | I2C_WRITE ), (char*)&reg, (int)1, true);
+    i2c_bus.write( (int)((sad << 1) | I2C_WRITE ), (char*)data, (int)data_len, false);
+}
+
+void RegisterWriter::write_register(uint8_t sad, uint8_t reg, uint8_t data) {
+    char data_to_send[2];
+
+    data_to_send[0] = reg;
+    data_to_send[1] = data;
+    i2c_bus.write( (int)((sad << 1) | I2C_WRITE ), &data_to_send[0], 2);
+}
+
+bool RegisterWriter::change_bits(uint8_t sad, uint8_t reg, uint8_t mask, uint8_t bits){
+    uint8_t value, read_bytes;
+    read_bytes = read_register(sad, reg, &value, 1);
+    if( read_bytes != 0 ){
+        value = value & ~mask;
+        value = value | (bits & mask);
+        write_register(sad, reg, value);
+        return true;
+        }
+    else{
+        //DEBUG_printf("Read before change_bits() failed.");
+        return false;
+        }
+}
+
+
+#endif
+
+