pinctrl: Add initial revision

pinctrl is a more flexible replacement for raspi-gpio. It gets its
configuration information from Device Tree, and can display and accept
GPIO names and header pin numbers.

Signed-off-by: Phil Elwell <[email protected]>

Author: pelwell

CMakeLists.txt

@@ -7,5 +7,6 @@ add_subdirectory(dtmerge)
 add_subdirectory(otpset)
 add_subdirectory(overlaycheck)
 add_subdirectory(ovmerge)
+add_subdirectory(pinctrl)
 add_subdirectory(raspinfo)
 add_subdirectory(vclog)

README.md

@@ -10,6 +10,9 @@ A collection of scripts and simple applications
 * [ovmerge](ovmerge/) - A tool for merging DT overlay source files (`*-overlay.dts`),
     flattening and sorting `.dts` files for easy comparison, displaying
     the include tree, etc.
+* [pinctrl](pinctrl/) - A more powerful replacement for raspi-gpio, a tool for
+    displaying and modifying the GPIO and pin muxing state of a system, bypassing
+    the kernel.
 * [raspinfo](raspinfo/) - A short script to dump information about the Pi. Intended for
     the submission of bug reports.
 * [vclog](vclog/) - A tool to get VideoCore 'assert' or 'msg' logs

pinctrl/CMakeLists.txt

@@ -0,0 +1,10 @@
+cmake_minimum_required(VERSION 3.10)
+
+set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wextra -Werror -pedantic")
+
+#set project name
+project(pinctrl)
+
+#add executables
+add_executable(pinctrl pinctrl.c gpiolib.c util.c gpiochip_bcm2835.c)
+install(TARGETS pinctrl RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR})

pinctrl/README.md

@@ -0,0 +1,36 @@
+
+# pinctrl
+
+pinctrl is a more powerful replacement for raspi-gpio, a tool for displaying
+and modifying the GPIO and pin muxing state of a system. It accesses the
+hardware directly, bypassing the kernel drivers, and as such requires root
+privilege (run with "sudo").
+
+The improvements over raspi-gpio include:
+
+* GPIO controllers are detected at runtime from Device Tree.
+* GPIOs can be referred to by name or number.
+* Pin mode (-p) switches the UI to be in terms of 40-way header pin numbers.
+* The "poll" command causes it to constantly monitor the specified pins,
+  displaying any level changes it see. For slow signals (up to a few hundred
+  kHz) it can act as a basic logic analyser.
+* The "get" and "set" keywords are optional in most cases.
+* Splitting into a general gpiolib library and a separate client application
+  allows new applications to be added easily.
+
+**Build Instructions**
+
+Install the prerequisites with "sudo apt install cmake" - you need at least version 3.10 of cmake. Run the following commands, either here or in the top-level directory to build and install everything:
+
+ - *cmake .*
+ - *make*
+ - *sudo make install*
+
+**Usage**
+
+* `sudo pinctrl`              (Display the state of all recognised GPIOs)
+* `sudo pinctrl -p`           (Show the state of the 40-way header pins)
+* `sudo pinctrl 4,6 op dl`    (Make GPIOs 4 and 6 outputs, driving low)
+* `sudo pinctrl poll BT_CTS,BT_RTS`    (Monitor the levels of the Bluetooth flow control signals)
+* `pinctrl funcs 9-11`        (List the available alternate functions on GPIOs 9, 10 and 11)
+* `pinctrl help`              (Show the full usage guide)

pinctrl/gpiochip.h

@@ -0,0 +1,42 @@
+#ifndef GPIOCHIP_H
+#define GPIOCHIP_H
+
+#include "gpiolib.h"
+
+#define DECLARE_GPIO_CHIP(name, compatible, iface, size, data) \
+    GPIO_CHIP_T name ## _chip __attribute__ ((section ("gpiochips"))) = \
+    { #name, compatible, iface, size, data }
+
+typedef struct GPIO_CHIP_INTERFACE_ GPIO_CHIP_INTERFACE_T;
+
+typedef struct GPIO_CHIP_
+{
+    const char *name;
+    const char *compatible;
+    const GPIO_CHIP_INTERFACE_T *interface;
+    int size;
+    uintptr_t data;
+} GPIO_CHIP_T;
+
+struct GPIO_CHIP_INTERFACE_
+{
+    void * (*gpio_create_instance)(const GPIO_CHIP_T *chip, const char *dtnode);
+    int (*gpio_count)(void *priv);
+    void * (*gpio_probe_instance)(void *priv, volatile uint32_t *base);
+    GPIO_FSEL_T (*gpio_get_fsel)(void *priv, uint32_t gpio);
+    void (*gpio_set_fsel)(void *priv, uint32_t gpio, const GPIO_FSEL_T func);
+    void (*gpio_set_drive)(void *priv, uint32_t gpio, GPIO_DRIVE_T drv);
+    void (*gpio_set_dir)(void *priv, uint32_t gpio, GPIO_DIR_T dir);
+    GPIO_DIR_T (*gpio_get_dir)(void *priv, uint32_t gpio);
+    int (*gpio_get_level)(void *priv, uint32_t gpio);  /* The actual level observed */
+    GPIO_DRIVE_T (*gpio_get_drive)(void *priv, uint32_t gpio);  /* What it is being driven as */
+    GPIO_PULL_T (*gpio_get_pull)(void *priv, uint32_t gpio);
+    void (*gpio_set_pull)(void *priv, uint32_t gpio, GPIO_PULL_T pull);
+    const char * (*gpio_get_name)(void *priv, uint32_t gpio);
+    const char * (*gpio_get_fsel_name)(void *priv, uint32_t gpio, GPIO_FSEL_T fsel);
+};
+
+extern const GPIO_CHIP_T __start_gpiochips;
+extern const GPIO_CHIP_T __stop_gpiochips;
+
+#endif