|
HFCC-01 Low-Level Software (LLSW) Rel_6802_HFCC-01-RP-CSAR-CB
|
Go to the source code of this file.
Enumerations | |
| enum | DOutLogic { DOUT_OG_GND = (1U) , DOUT_OG_OPEN = (2U) , DOUT_SO_SPLY = (3U) , DOUT_SO_OPEN = (4U) , DOUT_SG_SPLY = (5U) , DOUT_SG_GND = (6U) } |
| This is enum definition for the state logic discrete output. More... | |
| enum | DOutOvervoltageLockout { DOUT_OVL_DISABLE = 0U , DOUT_OVL_ENABLE = 1U } |
| Discrete Output Overvoltage Lockout (OVL) Protection Control State. More... | |
| enum | DOutUnderloadShutdown { DOUT_ULD_DISABLE = 0U , DOUT_ULD_ENABLE = 1U } |
| Discrete Output Underload Shutdown (ULD) Protection Control State. More... | |
| enum | DOutChannelType { DOUT_GND_OPEN = 1U , DOUT_SUPPLY_OPEN = 2U , DOUT_SUPPLY_GND = 3U } |
| This is enum definition for the type of mode discrete output. More... | |
Functions | |
| ModStatus | modDiscreteOut_devicesConfig (const DOutChannelBankDOutChannelBank DOutChannelBankDOutChannelBank, const DOutOvervoltageLockout overVoltage, const DOutUnderloadShutdown underLoad) |
| modDiscreteOut_devicesConfig. | |
| ModStatus | modDiscreteOut_write (const DOutChannelNum channelNum, const DOutLogic dOutLogic) |
| modDiscreteOut_write. | |
Discrete Output Module
| enum DOutChannelType |
| enum DOutLogic |
This is enum definition for the state logic discrete output.
| ModStatus modDiscreteOut_devicesConfig | ( | const DOutChannelBank | DOutChannelBank, |
| const DOutOvervoltageLockout | overVoltage, | ||
| const DOutUnderloadShutdown | underLoad ) |
modDiscreteOut_devicesConfig.
Set the discrete output device configuration. Overvoltage detection : Typical 36V Underload detection : Typical 2.5mA
| [in] | DOutChannelBank | The module bank channel. |
| [in] | overVoltage | The overvoltage lockout configuration. (ENABLE / DISABLE) |
| [in] | underLoad | The underload shutdown configuration. (ENABLE / DISABLE) Does not supported for below devices: DOUT_DEV1_BANK, DOUT_DEV2_BANK, DOUT_DEV3_BANK, DOUT_DEV4_BANK, DOUT_DEV9_BANK, DOUT_DEV10_BANK. |
| MD_SUCCESS | : Success. |
| MD_INVALID_CHANNEL | : The bank channel number is invalid. |
| MD_INVALID_INIT | : The module has not been initialized. |
| MD_INVALID_CONFIG | : The overvoltage or underload configuration parameter is invalid. |
| Requirement ID | Parent HLR ID | Detailed Low-Level Requirement Statement (EARS Format) | Software Unit Reference | Verification Method | Status |
|---|---|---|---|---|---|
| LLR_DISCRETEOUT_MODDISCRETEOUT_DEVICESCONFIG_01 | HLR_DOUT_39816 | WHEN bank validation fails (validateChannelBank() returns FALSE), the modDiscreteOut_devicesConfig() function SHALL abort processing and return MD_INVALID_CHANNEL. | modDiscreteOut.c:modDiscreteOut_devicesConfig() | Test | Closed |
| LLR_DISCRETEOUT_MODDISCRETEOUT_DEVICESCONFIG_02 | HLR_DOUT_39816 | WHEN the target card module state is not INIT, the modDiscreteOut_devicesConfig() function SHALL abort processing and return MD_INVALID_INIT. | modDiscreteOut.c:modDiscreteOut_devicesConfig() | Test | Closed |
| LLR_DISCRETEOUT_MODDISCRETEOUT_DEVICESCONFIG_03 | HLR_DOUT_39816 | WHEN overVoltage is DOUT_OVL_ENABLE, the modDiscreteOut_devicesConfig() function SHALL configure the overvoltage lockout bank flag to TRUE. | modDiscreteOut.c:modDiscreteOut_devicesConfig() | Test | Closed |
| LLR_DISCRETEOUT_MODDISCRETEOUT_DEVICESCONFIG_04 | HLR_DOUT_39816 | WHEN overVoltage is DOUT_OVL_DISABLE, the modDiscreteOut_devicesConfig() function SHALL configure the overvoltage lockout bank flag to FALSE. | modDiscreteOut.c:modDiscreteOut_devicesConfig() | Test | Closed |
| LLR_DISCRETEOUT_MODDISCRETEOUT_DEVICESCONFIG_05 | HLR_DOUT_39816 | WHEN underLoad is DOUT_ULD_ENABLE, the modDiscreteOut_devicesConfig() function SHALL configure the underload shutdown bank flag to TRUE. | modDiscreteOut.c:modDiscreteOut_devicesConfig() | Test | Closed |
| LLR_DISCRETEOUT_MODDISCRETEOUT_DEVICESCONFIG_06 | HLR_DOUT_39816 | WHEN underLoad is DOUT_ULD_DISABLE, the modDiscreteOut_devicesConfig() function SHALL configure the underload shutdown bank flag to FALSE. | modDiscreteOut.c:modDiscreteOut_devicesConfig() | Test | Closed |
| LLR_DISCRETEOUT_MODDISCRETEOUT_DEVICESCONFIG_07 | HLR_DOUT_39816 | WHEN bank configuration flags are resolved, the modDiscreteOut_devicesConfig() function SHALL program the target hardware device via discreteOut_devicesConfig(). | modDiscreteOut.c:modDiscreteOut_devicesConfig() | Test | Closed |
| LLR_DISCRETEOUT_MODDISCRETEOUT_DEVICESCONFIG_08 | HLR_DOUT_39816 | WHEN all operational processing completes successfully, the modDiscreteOut_devicesConfig() function SHALL return MD_SUCCESS. | modDiscreteOut.c:modDiscreteOut_devicesConfig() | Test | Closed |
| ModStatus modDiscreteOut_write | ( | const DOutChannelNum | channelNum, |
| const DOutLogic | dOutLogic ) |
modDiscreteOut_write.
Write the discrete output channel state.
| [in] | channelNum | The channel number. |
| [in] | dOutLogic | Write the discrete output channel state |
| MD_SUCCESS | : Success. |
| MD_INVALID_CHANNEL | : The channel number is invalid. |
| MD_INVALID_INIT | : The module has not been initialized. |
| MD_INVALID_CONFIG | : The configuration parameter is invalid. |
| Requirement ID | Parent HLR ID | Detailed Low-Level Requirement Statement (EARS Format) | Software Unit Reference | Verification Method | Status |
|---|---|---|---|---|---|
| LLR_DISCRETEOUT_MODDISCRETEOUT_WRITE_01 | HLR_DOUT_234 | WHEN channel validation fails (validateChannel() returns FALSE), the modDiscreteOut_write() function SHALL abort processing and return MD_INVALID_CHANNEL. | modDiscreteOut.c:modDiscreteOut_write() | Test | Closed |
| LLR_DISCRETEOUT_MODDISCRETEOUT_WRITE_02 | HLR_DOUT_234 | WHEN the target card module state is not INIT, the modDiscreteOut_write() function SHALL abort processing and return MD_INVALID_INIT. | modDiscreteOut.c:modDiscreteOut_write() | Test | Closed |
| LLR_DISCRETEOUT_MODDISCRETEOUT_WRITE_03 | HLR_DOUT_234 | WHEN the channel type is Ground/Open (DOUT_GND_OPEN) and dOutLogic is DOUT_OG_GND, the modDiscreteOut_write() function SHALL set hardware output state to TRUE. | modDiscreteOut.c:modDiscreteOut_write() | Test | Closed |
| LLR_DISCRETEOUT_MODDISCRETEOUT_WRITE_04 | HLR_DOUT_234 | WHEN the channel type is Ground/Open (DOUT_GND_OPEN) and dOutLogic is DOUT_OG_OPEN, the modDiscreteOut_write() function SHALL set hardware output state to FALSE. | modDiscreteOut.c:modDiscreteOut_write() | Test | Closed |
| LLR_DISCRETEOUT_MODDISCRETEOUT_WRITE_05 | HLR_DOUT_234 | WHEN the channel type is Supply/Open (DOUT_SUPPLY_OPEN) and dOutLogic is DOUT_SG_SPLY, the modDiscreteOut_write() function SHALL set hardware output state to TRUE. | modDiscreteOut.c:modDiscreteOut_write() | Test | Closed |
| LLR_DISCRETEOUT_MODDISCRETEOUT_WRITE_06 | HLR_DOUT_234 | WHEN the channel type is Supply/Open (DOUT_SUPPLY_OPEN) and dOutLogic is DOUT_SG_GND or DOUT_SG_OPEN, the modDiscreteOut_write() function SHALL set hardware output state to FALSE. | modDiscreteOut.c:modDiscreteOut_write() | Test | Closed |
| LLR_DISCRETEOUT_MODDISCRETEOUT_WRITE_07 | HLR_DOUT_234 | WHEN dOutLogic is invalid for the specified channel type, the modDiscreteOut_write() function SHALL abort processing and return MD_INVALID_VALUE. | modDiscreteOut.c:modDiscreteOut_write() | Test | Closed |
| LLR_DISCRETEOUT_MODDISCRETEOUT_WRITE_08 | HLR_DOUT_234 | WHEN state resolution succeeds, the modDiscreteOut_write() function SHALL write the physical discrete output line via discreteOut_writeChState(). | modDiscreteOut.c:modDiscreteOut_write() | Test | Closed |
| LLR_DISCRETEOUT_MODDISCRETEOUT_WRITE_09 | HLR_DOUT_234 | WHEN all operational processing completes successfully, the modDiscreteOut_write() function SHALL return MD_SUCCESS. | modDiscreteOut.c:modDiscreteOut_write() | Test | Closed |