CLASSIC
Modul: pwm
Rolle: constitutive
Konfidenz: 95%
SNIP_CLASSIC_PWM_SECTION_8_3_6_Pwm_GetOutputState
Wortlaut
8.3.6 Pwm_GetOutputState
[SWS_Pwm_00100] Definition of API function Pwm_GetOutputState ⌈
Service Name
Pwm_GetOutputState
Syntax
Pwm_OutputStateType Pwm_GetOutputState (
Pwm_ChannelType ChannelNumber
)
Service ID [hex]
0x05
Sync/Async
Synchronous
Reentrancy
Reentrant for different channel numbers
Parameters (in)
ChannelNumber
Numeric identifier of the PWM
▽
△
Parameters (inout)
None
Parameters (out)
None
Return value
Pwm_OutputStateType
PWM_HIGH The PWM output state is high
PWM_LOW The PWM output state is low
Description
Service to read the internal state of the PWM output signal.
Available via
Pwm.h
⌋
[SWS_Pwm_00022]
Upstream requirements: SRS_Pwm_12385
⌈The function Pwm_GetOutputState shall read the internal state of the PWM output
signal and return it as defined in the diagram below.
Regarding
error
detection,
the
requirements
[SWS_Pwm_00117],
[SWS_Pwm_00047],
[SWS_Pwm_10051]
and
[SWS_Pwm_20051]
are
applicable to the function Pwm_GetOutputState.⌋
[SWS_Pwm_10085]
Upstream requirements: SRS_BSW_00171
⌈The function Pwm_GetOutputState shall be pre compile time configurable On/Off
using the configuration parameter: PwmGetOutputState.⌋
[SWS_Pwm_20085]
Upstream requirements: SRS_BSW_00171
⌈The function Pwm_GetOutputState shall be configurable On/Off by the configuration parameter: PwmGetOutputState {PWM_GET_OUTPUT_STATE_API}.
Due to real time constraint and setting of the PWM channel (project dependant), the
output state can be modified just after the call of the service Pwm_GetOutputState.⌋
[SWS_Pwm_30051]
Upstream requirements: SRS_BSW_00323, SRS_BSW_00386
⌈If Pwm_GetOutputState is called before module initialization, or with an invalid
channel, it shall return PWM_LOW.⌋
Versionen & Provenienz · Zugeordnete Anforderungen
Diese Angaben zeigt der Versions-Explorer.
Begründung & Zuweisungs-Evidenz
Cited verbatim in the snippet (deterministic citation).
Dokumenten-Herkunft & Rückverfolgbarkeit
| Spezifikations-Dokument | SWS_PWMDriver.pdf |
|---|---|
| Dokumentseite | Seite 33 |
| Ziel-Modul | pwm (classic) |
| Ziel-Anforderung | SWS_Pwm_30051 |
| Semantische Rolle | constitutive |
| Automatisierungs-Konfidenz | 0.95 |