|
HFCC-01 Low-Level Software (LLSW) Rel_6802_HFCC-01-RP-CSAR-CB
|
Go to the source code of this file.
Functions | |
| ModStatus | modHeartbeat_setTimeout (const CardType cardType, const UInt32 timeout) |
| modHeartbeat_setTimeout. | |
| ModStatus | modHeartbeat_enableHeartbeat (const CardType cardType) |
| modHeartbeat_enableHeartbeat. | |
| ModStatus | modHeartbeat_disableHeartbeat (const CardType cardType) |
| modHeartbeat_disableHeartbeat. | |
| ModStatus | modHeartbeat_getElapsedTime (const CardType cardType, UInt32 *elapsedTime) |
| modHeartbeat_getElapsedTime. | |
| ModStatus | modHeartbeat_feedHeartbeat (const CardType cardType) |
| modHeartbeat_feedHeartbeat. | |
Heartbeat module
modHeartbeat_disableHeartbeat.
Disable the heartbeat.
| [in] | cardType | The card type. (MFB1_CARD or MFB2_CARD) |
| MD_SUCCESS | : Success. |
| MD_INVALID_CARD | : Invalid card type. |
| MD_OPEN_FAILED | : Card is not opened. |
| MD_CARD_NOT_READY | : MFB Card is not ready for operation. |
| Requirement ID | Parent HLR ID | Detailed Low-Level Requirement Statement (EARS Format) | Software Unit Reference | Verification Method | Status |
|---|---|---|---|---|---|
| LLR_HEARTBEAT_MODHEARTBEAT_DISABLEHEARTBEAT_01 | HLR_HBT_43821 | WHEN cardType is equal to MFB1_CARD, the modHeartbeat_disableHeartbeat() function SHALL select processor card MFB1 as the heartbeat hardware target. | modHeartbeat.c:modHeartbeat_disableHeartbeat() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_DISABLEHEARTBEAT_02 | HLR_HBT_43821 | WHEN cardType is equal to MFB2_CARD, the modHeartbeat_disableHeartbeat() function SHALL select processor card MFB2 as the heartbeat hardware target. | modHeartbeat.c:modHeartbeat_disableHeartbeat() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_DISABLEHEARTBEAT_03 | HLR_HBT_43821 | WHEN cardType is neither MFB1_CARD nor MFB2_CARD, the modHeartbeat_disableHeartbeat() function SHALL abort processing and return MD_INVALID_CARD. | modHeartbeat.c:modHeartbeat_disableHeartbeat() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_DISABLEHEARTBEAT_04 | HLR_HBT_43821 | WHEN the target processor card is not in the OPEN operating state, the modHeartbeat_disableHeartbeat() function SHALL abort processing and return MD_INVALID_STATE. | modHeartbeat.c:modHeartbeat_disableHeartbeat() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_DISABLEHEARTBEAT_05 | HLR_HBT_43821 | WHEN target card preconditions are satisfied, the modHeartbeat_disableHeartbeat() function SHALL disable the hardware heartbeat timer via heartbeat_disableHeartbeat(). | modHeartbeat.c:modHeartbeat_disableHeartbeat() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_DISABLEHEARTBEAT_06 | HLR_HBT_43821 | WHEN the heartbeat driver returns an error status (not equal to DRV_SUCCESS), the modHeartbeat_disableHeartbeat() function SHALL abort processing and return the module error code produced by errCheck(). | modHeartbeat.c:modHeartbeat_disableHeartbeat() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_DISABLEHEARTBEAT_07 | HLR_HBT_43821 | WHEN all operational processing completes successfully, the modHeartbeat_disableHeartbeat() function SHALL return MD_SUCCESS. | modHeartbeat.c:modHeartbeat_disableHeartbeat() | Test | Closed |
modHeartbeat_enableHeartbeat.
Enable the heartbeat.
| [in] | cardType | The card type. (MFB1_CARD or MFB2_CARD) |
| MD_SUCCESS | : Success. |
| MD_INVALID_CARD | : Invalid card type. |
| MD_OPEN_FAILED | : Card is not opened. |
| MD_INVALID_CONFIG | : Heartbeat timeout not configured. |
| MD_CARD_NOT_READY | : MFB Card is not ready for operation. |
| Requirement ID | Parent HLR ID | Detailed Low-Level Requirement Statement (EARS Format) | Software Unit Reference | Verification Method | Status |
|---|---|---|---|---|---|
| LLR_HEARTBEAT_MODHEARTBEAT_ENABLEHEARTBEAT_01 | HLR_HBT_43820 | WHEN cardType is equal to MFB1_CARD, the modHeartbeat_enableHeartbeat() function SHALL select processor card MFB1 as the heartbeat hardware target. | modHeartbeat.c:modHeartbeat_enableHeartbeat() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_ENABLEHEARTBEAT_02 | HLR_HBT_43820 | WHEN cardType is equal to MFB2_CARD, the modHeartbeat_enableHeartbeat() function SHALL select processor card MFB2 as the heartbeat hardware target. | modHeartbeat.c:modHeartbeat_enableHeartbeat() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_ENABLEHEARTBEAT_03 | HLR_HBT_43820 | WHEN cardType is neither MFB1_CARD nor MFB2_CARD, the modHeartbeat_enableHeartbeat() function SHALL abort processing and return MD_INVALID_CARD. | modHeartbeat.c:modHeartbeat_enableHeartbeat() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_ENABLEHEARTBEAT_04 | HLR_HBT_43820 | WHEN the target processor card is not in the OPEN operating state, the modHeartbeat_enableHeartbeat() function SHALL abort processing and return MD_INVALID_STATE. | modHeartbeat.c:modHeartbeat_enableHeartbeat() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_ENABLEHEARTBEAT_05 | HLR_HBT_43820 | WHEN the target processor card GPIO ready status is not MFB_READY, the modHeartbeat_enableHeartbeat() function SHALL abort processing and return MD_HARDWARE_NOT_READY. | modHeartbeat.c:modHeartbeat_enableHeartbeat() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_ENABLEHEARTBEAT_06 | HLR_HBT_43820 | WHEN target card preconditions are satisfied, the modHeartbeat_enableHeartbeat() function SHALL enable the hardware heartbeat timer via heartbeat_enableHeartbeat(). | modHeartbeat.c:modHeartbeat_enableHeartbeat() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_ENABLEHEARTBEAT_07 | HLR_HBT_43820 | WHEN the heartbeat driver returns an error status (not equal to DRV_SUCCESS), the modHeartbeat_enableHeartbeat() function SHALL abort processing and return the module error code produced by errCheck(). | modHeartbeat.c:modHeartbeat_enableHeartbeat() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_ENABLEHEARTBEAT_08 | HLR_HBT_43820 | WHEN all operational processing completes successfully, the modHeartbeat_enableHeartbeat() function SHALL return MD_SUCCESS. | modHeartbeat.c:modHeartbeat_enableHeartbeat() | Test | Closed |
modHeartbeat_feedHeartbeat.
Feed the heartbeat to prevent timeout.
| [in] | cardType | The card type. (MFB1_CARD or MFB2_CARD) |
| MD_SUCCESS | : Success. |
| MD_INVALID_CARD | : Invalid card type. |
| MD_OPEN_FAILED | : Card is not opened. |
| MD_INVALID_CONFIG | : Heartbeat not enabled. |
| MD_CARD_NOT_READY | : MFB Card is not ready for operation. |
| Requirement ID | Parent HLR ID | Detailed Low-Level Requirement Statement (EARS Format) | Software Unit Reference | Verification Method | Status |
|---|---|---|---|---|---|
| LLR_HEARTBEAT_MODHEARTBEAT_FEEDHEARTBEAT_01 | HLR_HBT_43823 | WHEN cardType is equal to MFB1_CARD, the modHeartbeat_feedHeartbeat() function SHALL select processor card MFB1 as the heartbeat hardware target. | modHeartbeat.c:modHeartbeat_feedHeartbeat() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_FEEDHEARTBEAT_02 | HLR_HBT_43823 | WHEN cardType is equal to MFB2_CARD, the modHeartbeat_feedHeartbeat() function SHALL select processor card MFB2 as the heartbeat hardware target. | modHeartbeat.c:modHeartbeat_feedHeartbeat() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_FEEDHEARTBEAT_03 | HLR_HBT_43823 | WHEN cardType is neither MFB1_CARD nor MFB2_CARD, the modHeartbeat_feedHeartbeat() function SHALL abort processing and return MD_INVALID_CARD. | modHeartbeat.c:modHeartbeat_feedHeartbeat() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_FEEDHEARTBEAT_04 | HLR_HBT_43823 | WHEN the target processor card is not in the OPEN operating state, the modHeartbeat_feedHeartbeat() function SHALL abort processing and return MD_INVALID_STATE. | modHeartbeat.c:modHeartbeat_feedHeartbeat() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_FEEDHEARTBEAT_05 | HLR_HBT_43823 | WHEN the target processor card GPIO ready status is not MFB_READY, the modHeartbeat_feedHeartbeat() function SHALL abort processing and return MD_HARDWARE_NOT_READY. | modHeartbeat.c:modHeartbeat_feedHeartbeat() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_FEEDHEARTBEAT_06 | HLR_HBT_43823 | WHEN the current card watchdog toggle state is TRUE, the modHeartbeat_feedHeartbeat() function SHALL assign the feed pattern to MOD_HEARTBEAT_FEED_HIGH and toggle the state to FALSE. | modHeartbeat.c:modHeartbeat_feedHeartbeat() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_FEEDHEARTBEAT_07 | HLR_HBT_43823 | WHEN the current card watchdog toggle state is FALSE, the modHeartbeat_feedHeartbeat() function SHALL assign the feed pattern to MOD_HEARTBEAT_FEED_LOW and toggle the state to TRUE. | modHeartbeat.c:modHeartbeat_feedHeartbeat() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_FEEDHEARTBEAT_08 | HLR_HBT_43823 | WHEN the feed pattern is determined, the modHeartbeat_feedHeartbeat() function SHALL write the watchdog toggle pattern to hardware via heartbeat_feedHeartbeat(). | modHeartbeat.c:modHeartbeat_feedHeartbeat() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_FEEDHEARTBEAT_09 | HLR_HBT_43823 | WHEN the heartbeat driver returns an error status (not equal to DRV_SUCCESS), the modHeartbeat_feedHeartbeat() function SHALL abort processing and return the module error code produced by errCheck(). | modHeartbeat.c:modHeartbeat_feedHeartbeat() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_FEEDHEARTBEAT_10 | HLR_HBT_43823 | WHEN all operational processing completes successfully, the modHeartbeat_feedHeartbeat() function SHALL return MD_SUCCESS. | modHeartbeat.c:modHeartbeat_feedHeartbeat() | Test | Closed |
modHeartbeat_getElapsedTime.
Get the elapsed time since the last heartbeat enabled or feed.
| [in] | cardType | The card type. (MFB1_CARD or MFB2_CARD) |
| [out] | elapsedTime | Pointer to store the elapsed time in microseconds. |
| MD_SUCCESS | : Success. |
| MD_INVALID_PARAM | : The provided address pointer is invalid. |
| MD_INVALID_CARD | : Invalid card type. |
| MD_OPEN_FAILED | : Card is not opened. |
| MD_INVALID_CONFIG | : Heartbeat not enabled. |
| MD_CARD_NOT_READY | : MFB Card is not ready for operation. |
| Requirement ID | Parent HLR ID | Detailed Low-Level Requirement Statement (EARS Format) | Software Unit Reference | Verification Method | Status |
|---|---|---|---|---|---|
| LLR_HEARTBEAT_MODHEARTBEAT_GETELAPSEDTIME_01 | HLR_HBT_43822 | WHEN the pointer elapsedTime is NULL (invalid), the modHeartbeat_getElapsedTime() function SHALL abort processing and return MD_INVALID_PARAM. | modHeartbeat.c:modHeartbeat_getElapsedTime() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_GETELAPSEDTIME_02 | HLR_HBT_43822 | WHEN cardType is equal to MFB1_CARD, the modHeartbeat_getElapsedTime() function SHALL select processor card MFB1 as the heartbeat hardware target. | modHeartbeat.c:modHeartbeat_getElapsedTime() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_GETELAPSEDTIME_03 | HLR_HBT_43822 | WHEN cardType is equal to MFB2_CARD, the modHeartbeat_getElapsedTime() function SHALL select processor card MFB2 as the heartbeat hardware target. | modHeartbeat.c:modHeartbeat_getElapsedTime() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_GETELAPSEDTIME_04 | HLR_HBT_43822 | WHEN cardType is neither MFB1_CARD nor MFB2_CARD, the modHeartbeat_getElapsedTime() function SHALL abort processing and return MD_INVALID_CARD. | modHeartbeat.c:modHeartbeat_getElapsedTime() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_GETELAPSEDTIME_05 | HLR_HBT_43822 | WHEN the target processor card is not in the OPEN operating state, the modHeartbeat_getElapsedTime() function SHALL abort processing and return MD_INVALID_STATE. | modHeartbeat.c:modHeartbeat_getElapsedTime() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_GETELAPSEDTIME_06 | HLR_HBT_43822 | WHEN target card preconditions are satisfied, the modHeartbeat_getElapsedTime() function SHALL read the elapsed timer ticks from hardware via heartbeat_getElapsedTime(). | modHeartbeat.c:modHeartbeat_getElapsedTime() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_GETELAPSEDTIME_07 | HLR_HBT_43822 | WHEN hardware timer read succeeds, the modHeartbeat_getElapsedTime() function SHALL convert elapsed ticks to microseconds using timer resolution and store into *elapsedTime. | modHeartbeat.c:modHeartbeat_getElapsedTime() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_GETELAPSEDTIME_08 | HLR_HBT_43822 | WHEN all operational processing completes successfully, the modHeartbeat_getElapsedTime() function SHALL return MD_SUCCESS. | modHeartbeat.c:modHeartbeat_getElapsedTime() | Test | Closed |
modHeartbeat_setTimeout.
Set the heartbeat timeout value based on hardware counter resolution.
| [in] | cardType | The card type. (MFB1_CARD or MFB2_CARD) |
| [in] | timeout | The timeout value in microseconds. Maximum value is 3000000 usec (3 seconds). |
| MD_SUCCESS | : Success. |
| MD_INVALID_CARD | : Invalid card type. |
| MD_OPEN_FAILED | : Card is not opened. |
| MD_INVALID_VALUE | : Invalid timeout value or hardware resolution is invalid. |
| MD_CARD_NOT_READY | : MFB Card is not ready for operation. |
| Requirement ID | Parent HLR ID | Detailed Low-Level Requirement Statement (EARS Format) | Software Unit Reference | Verification Method | Status |
|---|---|---|---|---|---|
| LLR_HEARTBEAT_MODHEARTBEAT_SETTIMEOUT_01 | HLR_HBT_43819 | WHEN timeout exceeds MOD_HEARTBEAT_TIMEOUT_LIMIT_USEC, the modHeartbeat_setTimeout() function SHALL abort processing and return MD_INVALID_VALUE. | modHeartbeat.c:modHeartbeat_setTimeout() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_SETTIMEOUT_02 | HLR_HBT_43819 | WHEN cardType is equal to MFB1_CARD, the modHeartbeat_setTimeout() function SHALL select processor card MFB1 as the heartbeat hardware target. | modHeartbeat.c:modHeartbeat_setTimeout() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_SETTIMEOUT_03 | HLR_HBT_43819 | WHEN cardType is equal to MFB2_CARD, the modHeartbeat_setTimeout() function SHALL select processor card MFB2 as the heartbeat hardware target. | modHeartbeat.c:modHeartbeat_setTimeout() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_SETTIMEOUT_04 | HLR_HBT_43819 | WHEN cardType is neither MFB1_CARD nor MFB2_CARD, the modHeartbeat_setTimeout() function SHALL abort processing and return MD_INVALID_CARD. | modHeartbeat.c:modHeartbeat_setTimeout() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_SETTIMEOUT_05 | HLR_HBT_43819 | WHEN the target processor card is not in the OPEN operating state, the modHeartbeat_setTimeout() function SHALL abort processing and return MD_INVALID_STATE. | modHeartbeat.c:modHeartbeat_setTimeout() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_SETTIMEOUT_06 | HLR_HBT_43819 | WHEN target card preconditions are satisfied, the modHeartbeat_setTimeout() function SHALL query timer tick resolution from hardware via heartbeat_getResolution(). | modHeartbeat.c:modHeartbeat_setTimeout() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_SETTIMEOUT_07 | HLR_HBT_43819 | WHEN the commanded timeout period has a non-zero remainder against timer tick resolution (timeoutNsec % resolutionNsec != 0), the modHeartbeat_setTimeout() function SHALL increment the calculated tick count by 1 to round up. | modHeartbeat.c:modHeartbeat_setTimeout() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_SETTIMEOUT_08 | HLR_HBT_43819 | WHEN timeout ticks are computed, the modHeartbeat_setTimeout() function SHALL configure the hardware timeout register via heartbeat_setTimeout(). | modHeartbeat.c:modHeartbeat_setTimeout() | Test | Closed |
| LLR_HEARTBEAT_MODHEARTBEAT_SETTIMEOUT_09 | HLR_HBT_43819 | WHEN all operational processing completes successfully, the modHeartbeat_setTimeout() function SHALL return MD_SUCCESS. | modHeartbeat.c:modHeartbeat_setTimeout() | Test | Closed |