CLASSIC
Modul: fr
Rolle: constitutive
Konfidenz: 95%
SNIP_CLASSIC_FR_SECTION_8_4_24_Fr_GetWakeupRxStatus
Wortlaut
8.4.24 Fr_GetWakeupRxStatus
[SWS_Fr_00587] Definition of API function Fr_GetWakeupRxStatus ⌈
Service Name
Fr_GetWakeupRxStatus
Syntax
Std_ReturnType Fr_GetWakeupRxStatus (
uint8 Fr_CtrlIdx,
uint8* Fr_WakeupRxStatusPtr
)
Service ID [hex]
0x2b
Sync/Async
Synchronous
Reentrancy
Non Reentrant for the same device
Parameters (in)
Fr_CtrlIdx
Index of FlexRay CC within the context of the FlexRay Driver.
Parameters (inout)
None
Parameters (out)
Fr_WakeupRxStatusPtr
Address where bitcoded wakeup reception status shall be stored.
Bit 0: Wakeup received on channel A indicator Bit 1: Wakeup
received on channel B indicator Bit 2-7: Unused
Return value
Std_ReturnType
E_OK: API call finished successfully.
E_NOT_OK: API call aborted due to errors.
Description
Gets the wakeup received information from the FlexRay controller.
Available via
Fr.h
⌋
[SWS_Fr_00588] ⌈The function Fr_GetWakeupRxStatus() shall perform the following tasks on FlexRay CC Fr_CtrIdx:
1. Read the wakeup pattern received indicators for channel A and channel B
and write it to the output parameter Fr_WakeupRxStatusPtr. The value of
*Fr_WakeupRxStatusPtr is bitcoded with the following meaning (Bit 0 = LSB,
Bit 7 = MSB):
Bit 0 Wakeup pattern received on channel A (1), otherwise (0)
Bit 1 Wakeup pattern received on channel B (1), otherwise (0)
Bit 2 Not used (always 0)
Bit 3 Not used (always 0)
Bit 4 Not used (always 0)
Bit 5 Not used (always 0)
Bit 6 Not used (always 0)
Bit 7 Not used (always 0)
2. Reset the wakeup received indication status information within the FlexRay controller.
3. Return E_OK.
⌋
[SWS_Fr_00589]
⌈If
the
function
Fr_GetWakeupRxStatus()
is
able
to
and
detects
a
hardware
error
while
performing
the
requested
functionality,
then
it
shall
call
Dem_SetEventStatus()
(FR_E_CTRL_TESTRESULT,
DEM_EVENT_STATUS_FAILED) and return E_NOT_OK.⌋
[SWS_Fr_00590] ⌈If development error detection for the Fr module is enabled, and if
the function Fr_GetWakeupRxStatus() is called before the successful initialization
of Fr, then the function Fr_GetWakeupRxStatus() shall raise the development error
FR_E_INIT_FAILED.⌋
[SWS_Fr_00591] ⌈If development error detection for the Fr module is enabled, then
the function Fr_GetWakeupRxStatus() shall check the validity of the parameter
Fr_CtrlIdx. If Fr_CtrlIdx is invalid, then the function Fr_GetWakeupRxStatus() shall raise the development error FR_E_INV_CTRL_IDX.⌋
[SWS_Fr_00592]
⌈If
development
error
detection
for
the
Fr
module
is
enabled,
then
the
function
Fr_GetWakeupRxStatus()
shall
check
whether
the
parameter
Fr_WakeupRxStatusPtr
is
a
NULL
pointer
(NULL_PTR).
If
Fr_WakeupRxStatusPtr is a NULL pointer, then the function Fr_GetWakeupRxStatus() shall raise the development error FR_E_PARAM_POINTER.⌋
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_FlexRayDriver.pdf |
|---|---|
| Dokumentseite | Seite 78 |
| Ziel-Modul | fr (classic) |
| Ziel-Anforderung | SWS_Std_00005 |
| Semantische Rolle | constitutive |
| Automatisierungs-Konfidenz | 0.95 |