ext/hal: Introduce STMEMS Standard C Drivers

This package contains platform independent drivers written in C
language for STMicroelectronics sensors. The aim of this package
is to provide a common, clean and stable interface to access sensor
registers.

Library is located in ext/hal/st/stmemsc/

Origin: ST Microelectronics
License: BSD-3-Clause
URL: https://www.st.com/en/embedded-software/c-driver-mems.html
Commit: v1.00
Purpose: provide a common and stable i/f to access sensor registers
Maintained-by: ST Microelectronics

Signed-off-by: Armando Visconti <[email protected]>

Author: avisconti

CODEOWNERS

@@ -189,6 +189,7 @@
 /ext/hal/nordic/                          @carlescufi @anangl
 /ext/hal/nxp/                             @MaureenHelm
 /ext/hal/st/                              @erwango
+/ext/hal/st/stmemsc/                      @avisconti
 /ext/hal/ti/simplelink/                   @vanti
 /ext/lib/crypto/mbedtls/                  @nashif
 /ext/lib/crypto/tinycrypt/                @ceolin

ext/hal/Kconfig

@@ -28,6 +28,8 @@ source "ext/hal/openisa/vega_sdk_riscv/Kconfig"
 
 source "ext/hal/st/stm32cube/Kconfig"
 
+source "ext/hal/st/stmemsc/Kconfig"
+
 source "ext/hal/st/lib/Kconfig"
 
 source "ext/hal/ti/simplelink/Kconfig"

ext/hal/st/CMakeLists.txt

@@ -1,2 +1,3 @@
 add_subdirectory_ifdef(CONFIG_HAS_STM32CUBE stm32cube)
+add_subdirectory_ifdef(CONFIG_HAS_STMEMSC stmemsc)
 add_subdirectory_ifdef(CONFIG_HAS_STLIB lib)

ext/hal/st/stmemsc/CMakeLists.txt

@@ -0,0 +1,58 @@
+# Makefile - STMems_Standard_C_drivers
+#
+# Copyright (c) 2019 STMicroelectronics
+#
+# SPDX-License-Identifier: Apache-2.0
+
+set(stmems_pids
+  a3g4250d
+  ais328dq
+  ais3624dq
+  h3lis331dl
+  hts221
+  i3g4250d
+  iis2dh
+  iis2dlpc
+  iis2mdc
+  iis328dq
+  iis3dhhc
+  ism303dac
+  ism330dlc
+  l20g20is
+  lis2de12
+  lis2dh12
+  lis2ds12
+  lis2dw12
+  lis2hh12
+  lis2mdl
+  lis331dlh
+  lis3de
+  lis3dhh
+  lis3dh
+  lis3mdl
+  lps22hb
+  lps22hh
+  lps25hb
+  lps33hw
+  lsm303agr
+  lsm303ah
+  lsm6ds3
+  lsm6dsl
+  lsm6dsm
+  lsm6dso
+  lsm6dsox
+  lsm9ds1
+  stts751
+  )
+
+foreach(stmems_pid ${stmems_pids})
+  string(TOUPPER ${stmems_pid} pid_to_upper)
+  if(CONFIG_USE_STDC_${pid_to_upper})
+    zephyr_include_directories(
+        ${stmems_pid}_STdC/driver/
+        )
+    zephyr_sources(
+        ${stmems_pid}_STdC/driver/${stmems_pid}_reg.c
+        )
+  endif()
+endforeach()

ext/hal/st/stmemsc/Kconfig

@@ -0,0 +1,128 @@
+# Kconfig - STMems_Standard_C_drivers
+#
+# Copyright (c) 2019 STMicroelectronics
+#
+# SPDX-License-Identifier: Apache-2.0
+
+config HAS_STMEMSC
+    bool
+    imply NEWLIB_LIBC
+    imply NEWLIB_LIBC_FLOAT_PRINTF
+
+if HAS_STMEMSC
+
+config USE_STDC_A3G4250D
+    bool
+
+config USE_STDC_AIS328DQ
+    bool
+
+config USE_STDC_AIS3624DQ
+    bool
+
+config USE_STDC_H3LIS331DL
+    bool
+
+config USE_STDC_HTS221
+    bool
+
+config USE_STDC_I3G4250D
+    bool
+
+config USE_STDC_IIS2DH
+    bool
+
+config USE_STDC_IIS2DLPC
+    bool
+
+config USE_STDC_IIS2MDC
+    bool
+
+config USE_STDC_IIS328DQ
+    bool
+
+config USE_STDC_IIS3DHHC
+    bool
+
+config USE_STDC_ISM303DAC
+    bool
+
+config USE_STDC_ISM330DLC
+    bool
+
+config USE_STDC_L20G20IS
+    bool
+
+config USE_STDC_LIS2DE12
+    bool
+
+config USE_STDC_LIS2DH12
+    bool
+
+config USE_STDC_LIS2DS12
+    bool
+
+config USE_STDC_LIS2DW12
+    bool
+
+config USE_STDC_LIS2HH12
+    bool
+
+config USE_STDC_LIS2MDL
+    bool
+
+config USE_STDC_LIS331DLH
+    bool
+
+config USE_STDC_LIS3DE
+    bool
+
+config USE_STDC_LIS3DHH
+    bool
+
+config USE_STDC_LIS3DH
+    bool
+
+config USE_STDC_LIS3MDL
+    bool
+
+config USE_STDC_LPS22HB
+    bool
+
+config USE_STDC_LPS22HH
+    bool
+
+config USE_STDC_LPS25HB
+    bool
+
+config USE_STDC_LPS33HW
+    bool
+
+config USE_STDC_LSM303AGR
+    bool
+
+config USE_STDC_LSM303AH
+    bool
+
+config USE_STDC_LSM6DS3
+    bool
+
+config USE_STDC_LSM6DSL
+    bool
+
+config USE_STDC_LSM6DSM
+    bool
+
+config USE_STDC_LSM6DSO
+    bool
+
+config USE_STDC_LSM6DSOX
+    bool
+
+config USE_STDC_LSM9DS1
+    bool
+
+config USE_STDC_STTS751
+    bool
+
+endif #HAS_STMEMSC

ext/hal/st/stmemsc/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2019, STMicroelectronics
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE COPYRIGHT HOLDER OR CONTRIBUTORS 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.

ext/hal/st/stmemsc/README

@@ -0,0 +1,58 @@
+C-Driver-MEMS
+#############
+
+Origin:
+   ST Microelectronics
+   https://www.st.com/en/embedded-software/c-driver-mems.html
+
+Status:
+   version v1.00
+
+Purpose:
+   ST Microelectronics standard C platform-independent drivers for MEMS
+   motion and environmental sensors.
+
+Description:
+   This package is an extract (examples have not been retained) of official
+   C-Driver-MEMS package written by ST Microelectronics.
+   It contains standard drivers for STMicroelectronics MEMS sensors to
+   provide a common and stable interface to access sensor registers.
+   For each supported sensor following files are provided:
+
+       - xyz_reg.c: contains the function to read/write 'xyz' sensor registers
+       - xyz_reg.h: contains structures and defines to describe in details
+                    the 'xyz' sensor registers.
+
+   The driver is platform-independent, you only need to define the two
+   functions for read and write transactions from the sensor hardware bus
+   (ie. SPI or I2C).
+
+   Define in your 'xyz' driver code the read and write functions that use the
+   I2C or SPI platform driver like the following:
+
+   /** Please note that is MANDATORY: return 0 -> no Error.**/
+   int platform_wr(void *handle, u8_t reg, u8_t *bufp, u16_t len);
+   int platform_rd(void *handle, u8_t reg, u8_t *bufp, u16_t len);
+
+   xyz_ctx_t xyz_ctx = {
+       .read_reg = (xyz_read_ptr) platform_rd,
+       .write_reg = (xyz_write_ptr) platform_wr,
+   };
+
+Dependencies:
+    None.
+
+URL:
+   https://www.st.com/en/embedded-software/c-driver-mems.html
+
+commit:
+   version v1.00
+
+Maintained-by:
+   ST Microelectronics
+
+License:
+   BSD-3-Clause
+
+License Link:
+   https://opensource.org/licenses/BSD-3-Clause