Adding support for waveshare pico ups-b shield

zephyrproject-rtos · Jul 14, 2023 · 21285d5 · 21285d5
1 parent 1323b1a
commit 21285d5
Show file tree

Hide file tree

Showing 5 changed files with 181 additions and 0 deletions.
diff --git a/boards/arm/rpi_pico/rpi_pico-common.dtsi b/boards/arm/rpi_pico/rpi_pico-common.dtsi
@@ -145,3 +145,4 @@ zephyr_udc0: &usbd {
 };
 
 pico_spi: &spi0 {};
+pico_i2c: &i2c1 {};
diff --git a/boards/shields/waveshare_ups/Kconfig.shield b/boards/shields/waveshare_ups/Kconfig.shield
@@ -0,0 +1,5 @@
+#Copyright (c) 2023 Joseph Yates
+# SPDX-License-Identifier: Apache-2.0
+
+config SHIELD_WAVESHARE_PICO_UPS_B
+	def_bool $(shields_list_contains,waveshare_pico_ups_b)
diff --git a/boards/shields/waveshare_ups/doc/index.rst b/boards/shields/waveshare_ups/doc/index.rst
@@ -0,0 +1,141 @@
+.. _waveshare_pico_ups_b_shield:
+
+Waveshare Pico UPS-B shield
+#################################
+
+Overview
+***************************
+
+The Waveshare Pico UPS-B shield is an uninterruptible Power supply (UPS) 
+module designed for the Raspberry Pi Pico which uses the Texas Instruments' INA219
+current/power Monitor. It communicates with the Raspberry Pi Pico over I2C
+
+.. figure:: waveshare_pico_ups_b.jpg
+   :align: center
+   :alt: Waveshare Pico UPS-B shield
+
+   Waveshare Pico UPS-B shield
+
+Hardware
+--------
+
+- INA219
+
+        - Senses bus voltages from 0 to 26 V 
+        - Reports current, voltage and power
+        - 16 Programmable Addresses
+        - SOT23-8 and SOIC-8 packages
+        - Calibration registers 
+
+- ETA6003
+
+        - Switching charger with power path management
+        - Up to 95% DC-DC efficiency
+        - 0mΩ power path MOSFET
+        - Up to 2.5A max charging current
+
+- Connectivity
+
+        - Raspberry Pi Pico compatible (I2C)
+        - 2 pin jst header for Li-po battery
+
+-------+-----------------------+---------------------------+
+| Name  | Function              | Usage                     |
++=======+=======================+===========================+
+| GP0   | None                  |                           |
++-------+-----------------------+---------------------------+
+| GP1   | None                  |                           |
++-------+-----------------------+---------------------------+
+| GP2   | None                  |                           |
++-------+-----------------------+---------------------------+
+| GP3   | None                  |                           |
++-------+-----------------------+---------------------------+
+| GP4   | None                  |                           |
++-------+-----------------------+---------------------------+
+| GP5   | None                  |                           |
++-------+-----------------------+---------------------------+
+| GP6   | I2C1_SDA ACTIVE_LOW   | INA219                    |
++-------+-----------------------+---------------------------+
+| GP7   | I2C1_SCL ACTIVE_LOW   | INA219                    |
++-------+-----------------------+---------------------------+
+| GP8   | None                  |                           |
++-------+-----------------------+---------------------------+
+| GP9   | None                  |                           |
++-------+-----------------------+---------------------------+
+| GP10  | None                  |                           |
++-------+-----------------------+---------------------------+
+| GP11  | None                  |                           |
++-------+-----------------------+---------------------------+
+| GP12  | None                  |                           |
++-------+-----------------------+---------------------------+
+| GP13  | None                  |                           |
++-------+-----------------------+---------------------------+
+| GP14  | None                  |                           |
++-------+-----------------------+---------------------------+
+| GP15  | None                  |                           |
++-------+-----------------------+---------------------------+
+| GP16  | None                  |                           |
++-------+-----------------------+---------------------------+
+| GP17  | None                  |                           |
++-------+-----------------------+---------------------------+
+| GP18  | None                  |                           |
++-------+-----------------------+---------------------------+
+| GP19  | None                  |                           |
++-------+-----------------------+---------------------------+
+| GP20  | None                  |                           |
++-------+-----------------------+---------------------------+
+| GP21  | None                  |                           |
++-------+-----------------------+---------------------------+
+| GP22  | None                  |                           |
++-------+-----------------------+---------------------------+
+| GP23  | None                  |                           |
++-------+-----------------------+---------------------------+
+| GP24  | None                  |                           |
++-------+-----------------------+---------------------------+
+| GP25  | None                  |                           |
++-------+-----------------------+---------------------------+
+| GP26  | None                  |                           |
++-------+-----------------------+---------------------------+
+| GP27  | None                  |                           |
++-------+-----------------------+---------------------------+
+| GP28  | None                  |                           |
++-------+-----------------------+---------------------------+
+
+
+- Power Supply
+
+        - 3.3V ~ 5V
+
+- Components
+
+        - Power switch
+        - Power LED
+        - Charging LED
+
+For more information about the Waveshare Pico UPS-B:
+
+- `Waveshare Pico UPS website`_
+- `INA219 data sheet`_
+- `ETA6003 data sheet`_
+
+Programming
+***********
+
+Set ``-DSHIELD=waveshare_pico_ups_b`` when you invoke ``west build`` or ``cmake`` in your Zephyr application. For
+example:
+
+.. zephyr-app-commands::
+   :zephyr-app: samples/sensor/ina219
+   :tool: all
+   :board: rpi_pico
+   :shield: waveshare_pico_ups_b
+   :goals: build flash
+
+.. _Waveshare Pico UPS website:
+   https://www.waveshare.com/wiki/Pico-UPS-B
+
+.. _INA219 data sheet:
+   https://www.ti.com/lit/ds/symlink/ina219.pdf
+
+.. _ETA6003 data sheet:
+   https://www.waveshare.com/w/upload/3/3f/ETA6003.pdf
diff --git a/boards/shields/waveshare_ups/doc/waveshare_pico_ups_b.jpg b/boards/shields/waveshare_ups/doc/waveshare_pico_ups_b.jpg
diff --git a/boards/shields/waveshare_ups/waveshare_pico_ups_b.overlay b/boards/shields/waveshare_ups/waveshare_pico_ups_b.overlay
@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) 2023 Joseph Yates
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+&pinctrl{
+	i2c1_default: i2c1_default{
+		group1{
+			pinmux = <I2C1_SDA_P6>, <I2C1_SCL_P7>;
+			input-enable;
+                        input-schmitt-enable;
+			bias-pull-up;
+		};
+	};	
+};
+
+&pico_i2c {
+	pinctrl-0 = <&i2c1_default>;
+        pinctrl-names = "default";
+	status = "okay";
+	clock-frequency = <I2C_BITRATE_FAST>;
+	waveshare_pico_ups: ina219@43 {
+		status = "okay";
+		compatible = "ti,ina219";
+		reg = <0x43>;
+		brng = <1>;
+                pg = <3>;
+                sadc = <12>;
+                badc = <12>;
+                shunt-milliohm = <100>;
+                lsb-microamp = <20>;
+	}; 
+};