gpio-7-segment
Vendor: Generic or vendor-independent
Note
An implementation of a driver matching this compatible is available in drivers/auxdisplay/auxdisplay_gpio_7seg.c.
Description
Common GPIO-driven 7-Segment Display
A 7-segment display is a form of electronic display device for displaying
decimal numerals that is an alternative to the more complex dot matrix
displays. Seven-segment displays are widely used in digital clocks, electronic
meters, basic calculators, and other electronic devices that display numerical
information.
This driver supports 7-segment displays driven by GPIOs, in a widely used
circuit design either common anode or common cathode.
In common anode design, digit-gpios and segment-gpios are configured as active
high and active low respectively, meaning that the current flows from
digit-gpios to segment-gpios. Vice versa for common cathode.
Example:
#include <zephyr/dt-bindings/gpio/gpio.h>
/ {
auxdisplay_0: digi-display {
compatible = "gpio-7-segment";
columns = <3>;
rows = <1>;
segment-gpios = <&gpio0 0 GPIO_ACTIVE_LOW>, /* A */
<&gpio0 1 GPIO_ACTIVE_LOW>, /* B */
<&gpio0 2 GPIO_ACTIVE_LOW>, /* C */
<&gpio0 3 GPIO_ACTIVE_LOW>, /* D */
<&gpio0 4 GPIO_ACTIVE_LOW>, /* E */
<&gpio0 5 GPIO_ACTIVE_LOW>, /* F */
<&gpio0 6 GPIO_ACTIVE_LOW>, /* G */
<&gpio0 7 GPIO_ACTIVE_LOW>; /* DP */
digit-gpios = <&gpio1 0 GPIO_ACTIVE_HIGH>, /* DIG1 */
<&gpio1 1 GPIO_ACTIVE_HIGH>, /* DIG2 */
<&gpio1 2 GPIO_ACTIVE_HIGH>; /* DIG3 */
refresh-period-ms = <1>;
};
};
Properties
Properties not inherited from the base binding file.
Name |
Type |
Details |
|---|---|---|
|
|
GPIOs used to control the segments.
Segments are usually labeled A to G, and DP for the decimal point. The
GPIOs must be listed in the order A, B, C, D, E, F, G and an optional DP.
The following diagram shows the segment layout:
-- A --
| |
F B
| |
-- G --
| |
E C
| |
-- D -- (DP)
The number of GPIOs must be 7 for a 7-segment display, or 8 for a 7-segment
display with a decimal point.
This property is required. |
|
|
GPIOs used to control the digits (the common anodes or cathodes).
The number of GPIOs must match the number of digits.
This property is required. |
|
|
The refresh period in milliseconds.
This is the time between the display of each digit. The refresh period
must be long enough to allow the segments to be driven and the digit to
be selected.
This property is required. |
|
|
Number of text columns that the display has
This property is required. |
|
|
Number of text rows that the display has
This property is required. |
Deprecated properties not inherited from the base binding file.
(None)
Properties inherited from the base binding file, which defines common properties that may be set on many nodes. Not all of these may apply to the “gpio-7-segment” compatible.
Name |
Type |
Details |
|---|---|---|
|
|
Indicates the operational status of the hardware or other
resource that the node represents. In particular:
- "okay" means the resource is operational and, for example,
can be used by device drivers
- "disabled" means the resource is not operational and the system
should treat it as if it is not present
For details, see "2.3.4 status" in Devicetree Specification v0.4.
Legal values: See Important properties for more information. |
|
|
This property is a list of strings that essentially define what
type of hardware or other resource this devicetree node
represents. Each device driver checks for specific compatible
property values to find the devicetree nodes that represent
resources that the driver should manage.
The recommended format is "vendor,device", The "vendor" part is
an abbreviated name of the vendor. The "device" is usually from
the datasheet.
The compatible property can have multiple values, ordered from
most- to least-specific. Having additional values is useful when the
device is a specific instance of a more general family, to allow the
system to match the most specific driver available.
For details, see "2.3.1 compatible" in Devicetree Specification v0.4.
This property is required. See Important properties for more information. |
|
|
Information used to address the device. The value is specific to
the device (i.e. is different depending on the compatible
property).
The "reg" property is typically a sequence of (address, length) pairs.
Each pair is called a "register block". Values are
conventionally written in hex.
For details, see "2.3.6 reg" in Devicetree Specification v0.4.
See Important properties for more information. |
|
|
Optional names given to each register block in the "reg" property.
For example:
/ {
soc {
#address-cells = <1>;
#size-cells = <1>;
uart@1000 {
reg = <0x1000 0x2000>, <0x3000 0x4000>;
reg-names = "foo", "bar";
};
};
};
The uart@1000 node has two register blocks:
- one with base address 0x1000, size 0x2000, and name "foo"
- another with base address 0x3000, size 0x4000, and name "bar"
|
|
|
Information about interrupts generated by the device, encoded as an array
of one or more interrupt specifiers. The format of the data in this property
varies by where the device appears in the interrupt tree. Devices with the same
"interrupt-parent" will use the same format in their interrupts properties.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
See Important properties for more information. |
|
|
Extended interrupt specifier for device, used as an alternative to
the "interrupts" property.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
|
|
|
Optional names given to each interrupt generated by a device.
The interrupts themselves are defined in either "interrupts" or
"interrupts-extended" properties.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
|
|
|
If present, this refers to the node which handles interrupts generated
by this device.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
|
|
|
Human readable string describing the device. Use of this property is
deprecated except as needed on a case-by-case basis.
For details, see "4.1.2 Miscellaneous Properties" in Devicetree
Specification v0.4.
See Important properties for more information. |
|
|
Information about the device's clock providers. In general, this property
should follow conventions established in the dt-schema binding:
https://github.com/devicetree-org/dt-schema/blob/main/dtschema/schemas/clock/clock.yaml
|
|
|
Optional names given to each clock provider in the "clocks" property.
|
|
|
This property encodes the number of <u32> cells used by address fields
in "reg" properties in this node's children.
For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
Specification v0.4.
|
|
|
This property encodes the number of <u32> cells used by size fields in
"reg" properties in this node's children.
For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
Specification v0.4.
|
|
|
DMA channel specifiers relevant to the device.
|
|
|
Optional names given to the DMA channel specifiers in the "dmas" property.
|
|
|
IO channel specifiers relevant to the device.
|
|
|
Optional names given to the IO channel specifiers in the "io-channels" property.
|
|
|
Mailbox / IPM channel specifiers relevant to the device.
|
|
|
Optional names given to the mbox specifiers in the "mboxes" property.
|
|
|
Power domain specifiers relevant to the device.
|
|
|
Optional names given to the power domain specifiers in the "power-domains" property.
|
|
|
Number of cells in power-domains property
|
|
|
Do not initialize device automatically on boot. Device should be manually
initialized using device_init().
|
|
|
Property to identify that a device can be used as wake up source.
When this property is provided a specific flag is set into the
device that tells the system that the device is capable of
wake up the system.
Wake up capable devices are disabled (interruptions will not wake up
the system) by default but they can be enabled at runtime if necessary.
|
|
|
Automatically configure the device for runtime power management after the
init function runs.
|
|
|
List of power states that will disable this device power.
|