Skip to content

vcgencmd: Document pmic_read_adc and measure_temp pmic, fix exit status #220

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelwell merged 1 commit into from
Oct 14, 2026
+36 −7
Merged

vcgencmd: Document pmic_read_adc and measure_temp pmic, fix exit status #220

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 36 additions & 7 deletions vcgencmd/vcgencmd.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,12 @@ previously been throttled due to under-voltage, but is not currently throttled
for any reason.
.
.TP
.B measure_temp
.BR measure_temp " [" pmic ]
Returns the temperature of the SoC as measured by the on-board temperature
sensor.
On Raspberry Pi 5,
.I vcgencmd measure_temp pmic
returns the temperature of the PMIC instead.
.
.TP
.BI measure_clock \ clock
Expand Down Expand Up @@ -130,6 +133,27 @@ sdram_p|
.TE
.
.TP
.BR pmic_read_adc " [" \fIchannel\fR ]
On Raspberry Pi 5, displays the readings of the ADCs in the PMIC: the current
drawn from and the voltage of each PMIC supply rail, plus the external 5V
supply voltage
.RB ( EXT5V_V ).
Without a parameter, every channel is listed, one per line, for example:
.IP
.EX
VDD_CORE_A current(7)=0.51794000A
VDD_CORE_V volt(15)=0.75186740V
EXT5V_V volt(24)=5.06788000V
.EE
.IP
To read a single channel, pass its name, for example
.IR "vcgencmd pmic_read_adc EXT5V_V" .
If the name is not recognised, every channel is listed.
.IP
The readings do not include USB current or anything else powered directly from
the 5V supply, because that power does not pass through the PMIC.
.
.TP
.B otp_dump
Displays the content of the One Time Programmable (OTP) memory, which is part
of the SoC. These are 32 bit values, indexed from 8 to 64. See the
Expand Down Expand Up @@ -182,26 +206,31 @@ or simply use the name of the configuration item.
.
.TP
.B mem_oom
Displays statistics on any Out Of Memory events occuring in the VC4 memory
Displays statistics on any Out Of Memory events occurring in the VC4 memory
space.
Not available on Raspberry Pi 5.
.
.TP
.B mem_reloc_stats
Displays statistics from the relocatable memory allocator on the VC4.
Not available on Raspberry Pi 5.
.
.TP
.B read_ring_osc
Returns the curent speed voltage and temperature of the ring oscillator.
Returns the current speed voltage and temperature of the ring oscillator.
.
.
.SH EXIT STATUS
.
.IP 0
Command completed successfully
.IP -1
Problem with VHCI
.IP -2
VideoCore returned an error
.IP "non-zero"
The mailbox device could not be opened, or VideoCore returned an error.
The shell sees the low 8 bits of the error value, so an error of \-1 is
reported as 255.
For example, a command that the firmware does not provide prints
.I \%error_msg="Command not \%registered"
and exits with status 255.
.
.
.SH SEE ALSO
Expand Down
Loading