Index: firmware/App/Controllers/PresOccl.c =================================================================== diff -u -rde5a0d43bdef611d963d11855bc958a8d8899a09 -ra3a01327c8fe80f65f6658ae6cbef4910a4a8033 --- firmware/App/Controllers/PresOccl.c (.../PresOccl.c) (revision de5a0d43bdef611d963d11855bc958a8d8899a09) +++ firmware/App/Controllers/PresOccl.c (.../PresOccl.c) (revision a3a01327c8fe80f65f6658ae6cbef4910a4a8033) @@ -50,13 +50,13 @@ NUM_OF_PRESSURE_STATES ///< Number of pressure/occlusion monitor states. } PRESSURE_STATE_T; -/// Defined states for the pressure and occlusion self test state machine. +/// Defined states for the pressure and occlusion self-test state machine. typedef enum PresOccl_Self_Test_States { PRESSURE_SELF_TEST_STATE_START = 0, ///< Self test start state. PRESSURE_TEST_STATE_IN_PROGRESS, ///< Self test in progress state. PRESSURE_TEST_STATE_COMPLETE, ///< Self test completed state. - NUM_OF_PRESSURE_SELF_TEST_STATES ///< Number of pressure/occlusion self test states. + NUM_OF_PRESSURE_SELF_TEST_STATES ///< Number of pressure/occlusion self-test states. } PRESSURE_SELF_TEST_STATE_T; // ********** private data ********** @@ -73,8 +73,8 @@ static OVERRIDE_F32_T dialInPumpOcclusion = {0.0, 0.0, 0.0, 0 }; ///< measured dialysate inlet pump occlusion pressure. static OVERRIDE_F32_T dialOutPumpOcclusion = {0.0, 0.0, 0.0, 0 }; ///< measured dialysate outlet pump occlusion pressure. -static PRESSURE_SELF_TEST_STATE_T presOcclSelfTestState = PRESSURE_SELF_TEST_STATE_START; ///< current pressure self test state. -static U32 bloodPumpSelfTestTimerCount = 0; ///< timer counter for pressure self test. +static PRESSURE_SELF_TEST_STATE_T presOcclSelfTestState = PRESSURE_SELF_TEST_STATE_START; ///< current pressure self-test state. +static U32 bloodPumpSelfTestTimerCount = 0; ///< timer counter for pressure self-test. static F32 arterialPressureLowLimitmmHG = 0.0; ///< lower alarm limit for arterial pressure. static F32 arterialPressureHighLimitmmHG = 0.0; ///< upper alarm limit for arterial pressure. @@ -108,14 +108,14 @@ /*********************************************************************//** * @brief - * The setPressureLimits function sets the lower and upper alarm limits \n + * The setPressureLimits function sets the lower and upper alarm limits * for a given pressure sensor. * @details * Inputs : none * Outputs : pressure limits - * @param sensor : pressure sensor we are setting limits for - * @param low : lower alarm limit (mmHg) - * @param high : upper alarm limit (mmHg) + * @param sensor pressure sensor we are setting limits for + * @param low lower alarm limit (mmHg) + * @param high upper alarm limit (mmHg) * @return none *************************************************************************/ void setPressureLimits( PRESSURE_SENSORS_T sensor, F32 low, F32 high ) @@ -133,20 +133,20 @@ break; default: - SET_ALARM_WITH_2_U32_DATA( ALARM_ID_SOFTWARE_FAULT, SW_FAULT_ID_PRES_OCCL_INVALID_PRES_SENSOR, sensor ) + SET_ALARM_WITH_2_U32_DATA( ALARM_ID_HD_SOFTWARE_FAULT, SW_FAULT_ID_PRES_OCCL_INVALID_PRES_SENSOR, sensor ) break; } } /*********************************************************************//** * @brief - * The setOcclusionThreshold function sets the occlusion pressure threshold \n + * The setOcclusionThreshold function sets the occlusion pressure threshold * for a given occlusion sensor. * @details * Inputs : none * Outputs : pressure threshold - * @param sensor : occlusion sensor we are setting threshold for - * @param threshold : pressure threshold above which indicates an occlusion (mmHg) + * @param sensor occlusion sensor we are setting threshold for + * @param threshold pressure threshold above which indicates an occlusion (mmHg) * @return none *************************************************************************/ void setOcclusionThreshold( OCCLUSION_SENSORS_T sensor, F32 threshold ) @@ -166,7 +166,7 @@ break; default: - SET_ALARM_WITH_2_U32_DATA( ALARM_ID_SOFTWARE_FAULT, SW_FAULT_ID_PRES_OCCL_INVALID_OCCL_SENSOR, sensor ) + SET_ALARM_WITH_2_U32_DATA( ALARM_ID_HD_SOFTWARE_FAULT, SW_FAULT_ID_PRES_OCCL_INVALID_OCCL_SENSOR, sensor ) break; } } @@ -193,7 +193,7 @@ break; default: - SET_ALARM_WITH_2_U32_DATA( ALARM_ID_SOFTWARE_FAULT, SW_FAULT_ID_PRES_OCCL_INVALID_STATE, presOcclState ) + SET_ALARM_WITH_2_U32_DATA( ALARM_ID_HD_SOFTWARE_FAULT, SW_FAULT_ID_PRES_OCCL_INVALID_STATE, presOcclState ) break; } @@ -203,7 +203,7 @@ /*********************************************************************//** * @brief - * The handlePresOcclInitState function handles the pres/occl initialize state \n + * The handlePresOcclInitState function handles the pres/occl initialize state * of the pressure/occlusion monitor state machine. * @details * Inputs : TBD @@ -219,7 +219,7 @@ /*********************************************************************//** * @brief - * The handlePresOcclContReadState function handles the continuous read state \n + * The handlePresOcclContReadState function handles the continuous read state * of the pressure/occlusion monitor state machine. * @details * Inputs : TBD @@ -255,7 +255,7 @@ /*********************************************************************//** * @brief - * The checkPressureLimits function gets the pressure/occlusion data \n + * The checkPressureLimits function gets the pressure/occlusion data * publication interval. * @details * Inputs : occlusion pressures for the pumps @@ -289,7 +289,7 @@ /*********************************************************************//** * @brief - * The getPublishPresOcclDataInterval function gets the pressure/occlusion data \n + * The getPublishPresOcclDataInterval function gets the pressure/occlusion data * publication interval. * @details * Inputs : presOcclDataPublishInterval @@ -320,7 +320,7 @@ /*********************************************************************//** * @brief - * The getMeasuredBloodPumpOcclusion function gets the measured blood pump \n + * The getMeasuredBloodPumpOcclusion function gets the measured blood pump * occlusion pressure. * @details * Inputs : bloodPumpOcclusion @@ -331,7 +331,7 @@ /*********************************************************************//** * @brief - * The getMeasuredDialInPumpOcclusion function gets the measured dialysate \n + * The getMeasuredDialInPumpOcclusion function gets the measured dialysate * inlet pump occlusion pressure. * @details * Inputs : dialInPumpOcclusion @@ -342,7 +342,7 @@ /*********************************************************************//** * @brief - * The getMeasuredDialOutPumpOcclusion function gets the measured dialysate \n + * The getMeasuredDialOutPumpOcclusion function gets the measured dialysate * outlet pump occlusion pressure. * @details * Inputs : dialOutPumpOcclusion @@ -353,7 +353,7 @@ /*********************************************************************//** * @brief - * The publishPresOcclData function publishes pressure/occlusion data at the \n + * The publishPresOcclData function publishes pressure/occlusion data at the * set interval. * @details * Inputs : TBD @@ -378,18 +378,18 @@ /*********************************************************************//** * @brief - * The execPresOcclTest function executes the state machine for the \n - * PresOccl self test. + * The execPresOcclTest function executes the state machine for the + * PresOccl self-test. * @details * Inputs : none * Outputs : none - * @return the current state of the PresOccl self test. + * @return the current state of the PresOccl self-test. *************************************************************************/ SELF_TEST_STATUS_T execPresOcclTest( void ) { SELF_TEST_STATUS_T result = SELF_TEST_STATUS_FAILED; - // TODO - implement self test(s) + // TODO - implement self-test(s) return result; } @@ -402,12 +402,12 @@ /*********************************************************************//** * @brief - * The testSetPresOcclDataPublishIntervalOverride function overrides the \n + * The testSetPresOcclDataPublishIntervalOverride function overrides the * pressure and occlusion data publish interval. * @details * Inputs : none * Outputs : presOcclDataPublishInterval - * @param value : override pressure and occlusion data publish interval with (in ms) + * @param value override pressure and occlusion data publish interval with (in ms) * @return TRUE if override successful, FALSE if not *************************************************************************/ BOOL testSetPresOcclDataPublishIntervalOverride( U32 value ) @@ -428,7 +428,7 @@ /*********************************************************************//** * @brief - * The testResetPresOcclDataPublishIntervalOverride function resets the override \n + * The testResetPresOcclDataPublishIntervalOverride function resets the override * of the pressure and occlusion data publish interval. * @details * Inputs : none @@ -451,12 +451,12 @@ /*********************************************************************//** * @brief - * The testSetArterialPressureOverride function overrides the measured arterial \n + * The testSetArterialPressureOverride function overrides the measured arterial * pressure. * @details * Inputs : none * Outputs : arterialPressure - * @param value : override arterial pressure (in mmHg) + * @param value override arterial pressure (in mmHg) * @return TRUE if override successful, FALSE if not *************************************************************************/ BOOL testSetArterialPressureOverride( F32 value ) @@ -475,7 +475,7 @@ /*********************************************************************//** * @brief - * The testResetArterialPressureOverride function resets the override of the \n + * The testResetArterialPressureOverride function resets the override of the * arterial pressure. * @details * Inputs : none @@ -498,12 +498,12 @@ /*********************************************************************//** * @brief - * The testSetVenousPressureOverride function overrides the measured venous \n + * The testSetVenousPressureOverride function overrides the measured venous * pressure. * @details * Inputs : none * Outputs : venousPressure - * @param value : override measured venous pressure with (in mmHg) + * @param value override measured venous pressure with (in mmHg) * @return TRUE if override successful, FALSE if not *************************************************************************/ BOOL testSetVenousPressureOverride( F32 value ) @@ -522,7 +522,7 @@ /*********************************************************************//** * @brief - * The testResetVenousPressureOverride function resets the override of the \n + * The testResetVenousPressureOverride function resets the override of the * venous pressure. * @details * Inputs : none @@ -545,12 +545,12 @@ /*********************************************************************//** * @brief - * The testSetBloodPumpOcclusionOverride function overrides the measured \n + * The testSetBloodPumpOcclusionOverride function overrides the measured * blood pump occlusion pressure.n * @details * Inputs : none * Outputs : bloodPumpOcclusion - * @param value : override measured blood pump occlusion pressure with (in mmHg) + * @param value override measured blood pump occlusion pressure with (in mmHg) * @return TRUE if override successful, FALSE if not *************************************************************************/ BOOL testSetBloodPumpOcclusionOverride( F32 value ) @@ -569,7 +569,7 @@ /*********************************************************************//** * @brief - * The testResetBloodPumpOcclusionOverride function resets the override of the \n + * The testResetBloodPumpOcclusionOverride function resets the override of the * measured blood pump occlusion pressure. * @details * Inputs : none @@ -592,12 +592,12 @@ /*********************************************************************//** * @brief - * The testSetDialInPumpOcclusionOverride function overrides the measured \n + * The testSetDialInPumpOcclusionOverride function overrides the measured * dialysate inlet pump occlusion pressure.n * @details * Inputs : none * Outputs : dialInPumpOcclusion - * @param value : override measured dialysate inlet pump occlusion pressure (in mmHg) + * @param value override measured dialysate inlet pump occlusion pressure (in mmHg) * @return TRUE if override successful, FALSE if not *************************************************************************/ BOOL testSetDialInPumpOcclusionOverride( F32 value ) @@ -616,7 +616,7 @@ /*********************************************************************//** * @brief - * The testResetDialInPumpOcclusionOverride function resets the override of the \n + * The testResetDialInPumpOcclusionOverride function resets the override of the * measured dialysate inlet pump occlusion pressure. * @details * Inputs : none @@ -639,12 +639,12 @@ /*********************************************************************//** * @brief - * The testSetDialOutPumpOcclusionOverride function overrides the measured \n + * The testSetDialOutPumpOcclusionOverride function overrides the measured * dialysate outlet pump occlusion pressure. * @details * Inputs : none * Outputs : dialOutPumpOcclusion - * @param value : override measured dialysate outlet pump occlusion pressure (in mmHg) + * @param value override measured dialysate outlet pump occlusion pressure (in mmHg) * @return TRUE if override successful, FALSE if not *************************************************************************/ BOOL testSetDialOutPumpOcclusionOverride( F32 value ) @@ -663,7 +663,7 @@ /*********************************************************************//** * @brief - * The testResetDialOutPumpOcclusionOverride function resets the override of the \n + * The testResetDialOutPumpOcclusionOverride function resets the override of the * measured dialysate outlet pump occlusion pressure. * @details * Inputs : none