Skip to content
This repository has been archived by the owner on Nov 11, 2024. It is now read-only.

Commit

Permalink
Documentation change only: account for STM32 in GPIO bank size guidance.
Browse files Browse the repository at this point in the history
  • Loading branch information
RobMeades committed Feb 25, 2024
1 parent 3a77d62 commit 9f9c864
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 9 deletions.
10 changes: 8 additions & 2 deletions port/platform/zephyr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,8 +153,14 @@ You will need an entry with `status = "okay"` for the device you intend to use (
# device it must be given as a STRING
transport-type = "uart0";
module-type = "U_CELL_MODULE_TYPE_SARA_R422";
# Pin numbers assume 32 pins per gpio, so the pin for
# <&gpio1 0 x> would be pin 32
# The ubxlib pin number is simply an integer counting up from zero,
# so you will need to know the number of pins per GPIO port on your
# MCU to work it out. For nRF52/nRF53 there are 32 pins per GPIO
# port, so the pin for <&gpio1 0 x> would be pin 32, while for
# STM32 therea are 16 pins per GPIO port which is easiest to comprehend
# when expressed in hex, so <&gpiob 0 x> (the STM32 GPIO device tree
# entries use a letter rather than a number), pin PB0 would be 0x10,
# <&gpiof 14 x>, pin PF14, would be 0x5e, etc.
pin-pwr-on = <10>;
pin-vint = <35>;
# This SARA-R422 device has GNSS inside it, which is indicated by
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,19 +37,19 @@ properties:
# pinEnablePower
pin-enable-power:
type: int
description: "The GPIO output pin (an integer, assuming 32 pins per GPIO bank) that enables power to the cellular module (e.g. through a relay or some such); not usually required."
description: "The GPIO output pin (an integer, counting from zero up through the GPIO banks) that enables power to the cellular module (e.g. through a relay or some such); not usually required."
# pinPwrOn
pin-pwr-on:
type: int
description: "The GPIO output pin (an integer, assuming 32 pins per GPIO bank) that is connected to the PWR_ON pin of the cellular module."
description: "The GPIO output pin (an integer, counting from zero up through the GPIO banks) that is connected to the PWR_ON pin of the cellular module."
# pinVint
pin-vint:
type: int
description: "The GPIO input pin (an integer, assuming 32 pins per GPIO bank) that is connected to the VINT pin of the cellular module."
description: "The GPIO input pin (an integer, counting from zero up through the GPIO banks) that is connected to the VINT pin of the cellular module."
# pinDtrPowerSaving
pin-dtr-power-saving:
type: int
description: "The GPIO output pin (an integer, assuming 32 pins per GPIO bank) that is connected to the DTR pin of the cellular module because you intend to use the DTR pin to tell the module whether it can enter power-saving."
description: "The GPIO output pin (an integer, counting from zero up through the GPIO banksk) that is connected to the DTR pin of the cellular module because you intend to use the DTR pin to tell the module whether it can enter power-saving."
# Associated network configurations
network:
type: phandles
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ properties:
# pinSelect for SPI
spi-pin-select:
type: int
description: "The GPIO output pin (an integer, assuming 32 pins per GPIO bank) to use for SPI chip select; if you do not specify a pin then spi-index-select is used and if spi-index-select is not specified index 0 is used."
description: "The GPIO output pin (an integer, counting from zero up through the GPIO banks) to use for SPI chip select; if you do not specify a pin then spi-index-select is used and if spi-index-select is not specified index 0 is used."
# indexSelect for SPI
spi-index-select:
type: int
Expand Down Expand Up @@ -89,11 +89,11 @@ properties:
# pinEnablePower
pin-enable-power:
type: int
description: "The GPIO output pin (an integer, assuming 32 pins per GPIO bank) that enables power to the GNSS device (e.g. through a relay or some such); not usually required."
description: "The GPIO output pin (an integer, counting from zero up through the GPIO banks) that enables power to the GNSS device (e.g. through a relay or some such); not usually required."
# pinDataReady
pin-data-ready:
type: int
description: "The GPIO output pin (an integer, assuming 32 pins per GPIO bank) that is connected to the Data Ready pin of the GNSS device; provided for future compatibility only, currently ignored."
description: "The GPIO output pin (an integer,counting from zero up through the GPIO banks) that is connected to the Data Ready pin of the GNSS device; provided for future compatibility only, currently ignored."
# i2cAddress
i2c-address:
type: int
Expand Down

0 comments on commit 9f9c864

Please sign in to comment.