PCV services: Difference between revisions

| 0 || ShutdownSystem

| 1 || RebootSystem

| 2 || GetWakeupReason

| 3 || GetShutdownReason

| 4 || GetAcOk

| 5 || GetBoardPowerControlEvent

| 6 || [2.0.0+] GetSleepButtonState

| 7 || [2.0.0+] GetPowerEvent

| 8 || [2.0.0-9.2.0] CreateWakeupTimer

| 9 || [2.0.0-9.2.0] CancelWakeupTimer

| 11 || [3.0.0-9.2.0] CreateWakeupTimerEx

| 12 || [3.0.0-9.2.0] GetLastEnabledWakeupTimerType

| 13 || [3.0.0-9.2.0] CleanAllWakeupTimers

| 14 || [6.0.0+] GetPowerButton

| 15 || [10.0.0+]

No input, returns a total of 0x10-bytes of output. [3.0.0+] Now returns a total of 0xC-bytes of output.

| 0 || GetRtcTime

| 1 || SetRtcTime

| 2 || GetRtcResetDetected

| 3 || [2.0.0+] ClearRtcResetDetected

| 4 || [3.0.0+] SetUpRtcResetOnShutdown

| 0 || ShutdownSystem

| 1 || RebootSystem

| 2 || GetWakeupReason

| 3 || GetShutdownReason

| 4 || GetAcOk

| 5 || GetBoardPowerControlEvent

| 0 || GetSleepButtonState

| 1 || GetPowerEvent

| 0 || CreateWakeupTimer

| 1 || CancelWakeupTimer

| [1.0.0-7.0.1] 0 || SetPowerEnabled

| [1.0.0-7.0.1] 1 || SetClockEnabled

| [1.0.0-7.0.1] 2 || SetClockRate

| [1.0.0-7.0.1] 3 || GetClockRate

| [1.0.0-7.0.1] 4 || GetState

| [1.0.0-7.0.1] 5 || GetPossibleClockRates

| [1.0.0-7.0.1] 6 || SetMinVClockRate

| [1.0.0-7.0.1] 7 || SetReset

| [1.0.0-7.0.1] 8 || SetVoltageEnabled

| [1.0.0-7.0.1] 9 || GetVoltageEnabled

| [1.0.0-7.0.1] 10 || GetVoltageRange

| [1.0.0-7.0.1] 11 || SetVoltageValue

| [1.0.0-7.0.1] 12 || GetVoltageValue

| [1.0.0-7.0.1] 13 || GetTemperatureThresholds

| [1.0.0-7.0.1] 14 || SetTemperature

| [1.0.0-5.1.0] 15 || Initialize

| [1.0.0-5.1.0] 16 || IsInitialized

| [1.0.0-5.1.0] 17 || Finalize

| [3.0.0-7.0.1] 18 || PowerOn

| [3.0.0-7.0.1] 19 || PowerOff

| [3.0.0-7.0.1] 20 || ChangeVoltage

| [3.0.0-7.0.1] 21 || GetPowerClockInfoEvent

| [3.0.0-7.0.1] 22 || GetOscillatorClock

| [3.0.0-7.0.1] 23 || GetDvfsTable

| [3.0.0-7.0.1] 24 || GetModuleStateTable

| [3.0.0-7.0.1] 25 || GetPowerDomainStateTable

| 26 || [3.0.0+] GetFuseInfo

| 27 || [5.0.0+] GetDramId

[7.0.0+] The type-0xA output buffers were replaced with type-0x22 output buffers, for the following: GetDvfsTable, GetModuleStateTable, and GetPowerDomainStateTable.

Takes a [[#PowerDomain|PowerDomain]] and returns a bool indicating the status of the requested voltage block.

Takes a [[#PowerDomain|PowerDomain]] and returns an u32 voltage value for the requested voltage block.

| 0 || ReleaseControl

| 0 || SetClockRate

| 3 || GetPossibleClockRates

| 4 || GetClockInfoEvent

| 5 || GetClockModuleNumLimit

Takes a [[#Module|DeviceCode]] and an u32. Returns an [[#IClkrstSession]].

| 0 || [[#ReleaseControl]]

== ReleaseControl ==

Takes a [[#Module|Module]]. No output.

| 1 || GetPowerDomainStateTable

| 2 || GetPowerInfoEvent

| 3 || GetPowerModuleNumLimit

Takes a [[#PowerDomain|DeviceCode]] and returns an [[#IRegulatorSession]].

| 0 || [[#SetVoltageEnabled]]

| 2 || [[#GetVoltageEnabled]]

| 5 || [[#SetVoltageValue]]

| 0 || [[#GetRtcTime]]

| 1 || [[#SetRtcTime]]

| 2 || [[#SetUpRtcResetOnShutdown]]

| 3 || [[#GetRtcResetDetected]]

| 4 || [[#ClearRtcResetDetected]]

== GetRtcTime ==

Same as GetRtcTime from [[#bpc:r|bpc:r]], but takes an extra [[Bus_services#I2cDevice|DeviceCode]], which [[#bpc:r|bpc:r]] hardcodes to 0x3B000001 (max77620_rtc0) instead.

== SetRtcTime ==

Same as SetRtcTime from [[#bpc:r|bpc:r]], but takes an extra [[Bus_services#I2cDevice|DeviceCode]], which [[#bpc:r|bpc:r]] hardcodes to 0x3B000001 (max77620_rtc0) instead.

== SetUpRtcResetOnShutdown ==

Takes an u8 '''DoReset''' and a [[Bus_services#I2cDevice|DeviceCode]]. Similar to SetUpRtcResetOnShutdown from [[#bpc:r|bpc:r]], but this version assigns the provided boolean value on a per-client basis (instead of a global variable) and checks it when the current [[PSC_services#Power_Management_States|power state]] is "ReadyShutdown".

== GetRtcResetDetected ==

Same as GetRtcResetDetected from [[#bpc:r|bpc:r]], but takes an extra [[Bus_services#I2cDevice|DeviceCode]], which [[#bpc:r|bpc:r]] hardcodes to 0x3B000001 (max77620_rtc0) instead.

== ClearRtcResetDetected ==

Same as ClearRtcResetDetected from [[#bpc:r|bpc:r]], but takes an extra [[Bus_services#I2cDevice|DeviceCode]], which [[#bpc:r|bpc:r]] hardcodes to 0x3B000001 (max77620_rtc0) instead.

! Cmd || Name || Notes

| 0 || GetStandardUserSystemClock || Returns an [[#ISystemClock]].

| 1 || GetStandardNetworkSystemClock || Returns an [[#ISystemClock]].

| 2 || GetStandardSteadyClock || Returns an [[#ISteadyClock]].

| 3 || GetTimeZoneService || Returns an [[#ITimeZoneService]].

| 4 || GetStandardLocalSystemClock || Returns an [[#ISystemClock]].

| 5 || [4.0.0+] GetEphemeralNetworkSystemClock || Returns an [[#ISystemClock]].

| 20 || [6.0.0+] GetSharedMemoryNativeHandle ||

| 30 || [6.0.0+] GetStandardNetworkClockOperationEventReadableHandle ||

| 31 || [6.0.0+] GetEphemeralNetworkClockOperationEventReadableHandle ||

| 50 || [4.0.0+] SetStandardSteadyClockInternalOffset ||

| 100 || IsStandardUserSystemClockAutomaticCorrectionEnabled ||

| 101 || SetStandardUserSystemClockAutomaticCorrectionEnabled ||

| 102 || [5.0.0+] GetStandardUserSystemClockInitialYear ||

| 200 || [3.0.0+] IsStandardNetworkSystemClockAccuracySufficient ||

| 201 || [6.0.0+] GetStandardUserSystemClockAutomaticCorrectionUpdatedTime ||

| 300 || [4.0.0+] CalculateMonotonicSystemClockBaseTimePoint ||

| 400 || [4.0.0+] GetClockSnapshot ||

| 401 || [4.0.0+] GetClockSnapshotFromSystemClockContext ||

| 500 || [4.0.0+] CalculateStandardUserSystemClockDifferenceByUser ||

| 501 || [4.0.0+] CalculateSpanBetween ||

! Cmd || Name || Notes

| 0 || GetCurrentTimePoint || No input, returns an output [[#SteadyClockTimePoint]].

| 2 || GetTestOffset || No input, returns an output [[#TimeSpanType]].

| 3 || SetTestOffset || Takes an input [[#TimeSpanType]], no output.

| 100 || [2.0.0+] GetRtcValue || No input, returns an output s64.

| 101 || [2.0.0+] IsRtcResetDetected || No input, returns an output u8 bool.

| 102 || [2.0.0+] GetSetupResultValue || No input, returns an output u32.

| 200 || [3.0.0+] GetInternalOffset || No input, returns an output [[#TimeSpanType]].

| 201 || [3.0.0-3.0.2] SetInternalOffset || Takes an input [[#TimeSpanType]], no output.

=== SteadyClockTimePoint ===

{| class="wikitable" border="1"

| 0x0 || 0x8|| A u64 representing a point in time.

| 0x8 || 0x10 || An ID representing the clock source.

This is a 0x18-byte struct.

=== TimeSpanType ===

This is an u64.

! Cmd || Name || Notes

| 0 || GetCurrentTime || Returns an output [[#PosixTime]].

| 1 || SetCurrentTime || Takes an input [[#PosixTime]].

| 2 || GetSystemClockContext || Returns an output [[#SystemClockContext]].

| 3 || SetSystemClockContext || Takes an input [[#SystemClockContext]].

| 4 || [9.0.0+] GetOperationEventReadableHandle ||

=== PosixTime ===

This is an s64 for UTC POSIX time.

=== SystemClockContext ===

This is an 0x20-byte struct.

{| class="wikitable" border="1"

| 0x0 || 0x8|| a [[#PosixTime]] representing the system clock epoch.

! Cmd || Name || Notes

| 0 || GetDeviceLocationName || No input, returns an output [[#LocationName]].

| 1 || SetDeviceLocationName || Takes an input [[#LocationName]], no output.

| 2 || GetTotalLocationNameCount || No input, returns an output s32.

| 3 || LoadLocationNameList ||

| 4 || LoadTimeZoneRule || Takes an input [[#LocationName]] and a type-0x16 output buffer for [[#TimeZoneRule]], no output.

| 5 || [2.0.0+] GetTimeZoneRuleVersion ||  No input, returns an output [[#TimeZoneRuleVersion]].

| 6 || [5.0.0+] GetDeviceLocationNameAndUpdatedTime ||

| 100 || ToCalendarTime || Takes an input [[#PosixTime]] and a type-0x15 input buffer for [[#TimeZoneRule]], returns an output [[#CalendarTime]] and [[#CalendarAdditionalInfo]].

| 101 || ToCalendarTimeWithMyRule || Takes an input [[#PosixTime]], returns an output [[#CalendarTime]] and [[#CalendarAdditionalInfo]].

| 201 || ToPosixTime || Takes an input [[#CalendarTime]], a type-0x15 input buffer for [[#TimeZoneRule]], an type-0xA output buffer for [[#PosixTime]] array, and returns an output s32.

| 202 || ToPosixTimeWithMyRule || Takes an input [[#CalendarTime]], an type-0xA output buffer for [[#PosixTime]] array, and returns an output s32.

=== LoadLocationNameList ===

Takes an input s32 LocationName_index and a type-0x6 output buffer for [[#LocationName]], returns an output s32 for total output entries.

 

This contains a TimeZone location string with a max size of 0x24 bytes.

=== TimeZoneRule ===

This is an 0x4000-byte struct. Official sw uses fixed-size 0x4000 for the buffer size with the above commands.

This is loaded from the [[Title_list|TimeZoneBinary]] title with the specified LocationName under the zoneinfo/ directory, the content is then converted into this TimeZoneRule structure.

The files contained under zoneinfo/ directory are Tzif2 files without Tzif1 header and data at the begining of them (see [https://tools.ietf.org/html/rfc8536 RFC8536] for more information).

The conversion of a Tzif2 file to a TimeZoneRule structure is based on [https://github.com/eggert/tz/blob/master/localtime.c tz database code] with some custom modifications (Leap seconds aren't handled, no usage of "posixrules" and Tzif1 support stripped out).

{| class="wikitable" border="1"

| 0x2338 || 0x10 * 128 || ttis (time type information), struct ttinfo[1000]

=== ttinfo ===

This is an 0x10-byte struct.

Represent a Time Type Information used in [[#TimeZoneRule]].

{| class="wikitable" border="1"

=== TimeZoneRuleVersion ===

This is an u128.

=== CalendarTime ===

|-

This is an 0x8-byte struct.

=== CalendarAdditionalInfo ===

{| class="wikitable" border="1"

| 0x0 || 0x4 || 0-based day-of-week.

This is an 0x18-byte struct. This stores timezone info.