Index: firmware/App/Modes/ModeTxParams.c =================================================================== diff -u -rcd19fd5095128315982b9ef810bd45e68eff8deb -r79c2105d7ec35f3caeb977f6e2cc1b494853d211 --- firmware/App/Modes/ModeTxParams.c (.../ModeTxParams.c) (revision cd19fd5095128315982b9ef810bd45e68eff8deb) +++ firmware/App/Modes/ModeTxParams.c (.../ModeTxParams.c) (revision 79c2105d7ec35f3caeb977f6e2cc1b494853d211) @@ -93,7 +93,7 @@ const TREATMENT_PARAMS_PROPERTIES_T TREAT_PARAMS_PROPERTIES[ NUM_OF_TREATMENT_PARAMS ] = { { CRITICAL_DATA_TYPE_U32, {.uInt=100}, {.uInt=500}, {.uInt=100} }, // TREATMENT_PARAM_BLOOD_FLOW - { CRITICAL_DATA_TYPE_U32, {.uInt=100}, {.uInt=600}, {.uInt=100} }, // TREATMENT_PARAM_DIALYSATE_FLOW + { CRITICAL_DATA_TYPE_U32, {.uInt=50}, {.uInt=600}, {.uInt=100} }, // TREATMENT_PARAM_DIALYSATE_FLOW { CRITICAL_DATA_TYPE_U32, {.uInt=60}, {.uInt=480}, {.uInt=240} }, // TREATMENT_PARAM_TREATMENT_DURATION { CRITICAL_DATA_TYPE_U32, {.uInt=100}, {.uInt=300}, {.uInt=100} }, // TREATMENT_PARAM_SALINE_BOLUS_VOLUME { CRITICAL_DATA_TYPE_U32, {.uInt=0}, {.uInt=2}, {.uInt=0} }, // TREATMENT_PARAM_ACID_CONCENTRATE @@ -203,7 +203,8 @@ * The resetAllTreatmentParameters function resets treatment parameters * to default values. * @details \b Inputs: none - * @details \b Outputs: All treatment parameters reset to default values. + * @details \b Outputs: All treatment parameters reset to default values and + * original and staged treatment parameters reset to zero. * @return none *************************************************************************/ static void resetAllTreatmentParameters( void ) @@ -237,6 +238,7 @@ * @brief * The setTreatmentParameterU32 function sets a given unsigned integer * treatment parameter to a given value. + * @details \b Alarm: ALARM_ID_TD_SOFTWARE_FAULT if given param is invalid * @details \b Inputs: treatmentParameters[] * @details \b Outputs: treatmentParameters[] * @param param ID of treatment parameter to set unsigned integer value for @@ -274,6 +276,7 @@ * @brief * The setTreatmentParameterS32 function sets a given signed integer treatment * parameter to a given value. + * @details \b Alarm: ALARM_ID_TD_SOFTWARE_FAULT if given param is invalid * @details \b Inputs: treatmentParameters[] * @details \b Outputs: treatmentParameters[] * @param param ID of treatment parameter to set signed integer value for @@ -311,6 +314,7 @@ * @brief * The setTreatmentParameterF32 sets a given floating point treatment parameter * to a given value. + * @details \b Alarm: ALARM_ID_TD_SOFTWARE_FAULT if given param is invalid * @details \b Inputs: treatmentParameters[] * @details \b Outputs: treatmentParameters[] * @param param ID of treatment parameter to set floating point value for @@ -348,6 +352,7 @@ * @brief * The getTreatmentParameterU32 function gets the value of a given unsigned * integer treatment parameter. + * @details \b Alarm: ALARM_ID_TD_SOFTWARE_FAULT if given param is invalid * @details \b Inputs: treatmentParameters[] * @details \b Outputs: none * @param param ID of treatment parameter to get unsigned integer value for @@ -376,6 +381,7 @@ * @brief * The getTreatmentParameterS32 function gets the value of a given signed * integer treatment parameter. + * @details \b Alarm: ALARM_ID_TD_SOFTWARE_FAULT if given param is invalid * @details \b Inputs: treatmentParameters[] * @details \b Outputs: none * @param param ID of treatment parameter to get signed integer value for @@ -404,6 +410,7 @@ * @brief * The getTreatmentParameterF32 function gets the value of a given floating point * treatment parameter. + * @details \b Alarm: ALARM_ID_TD_SOFTWARE_FAULT if given param is invalid * @details \b Inputs: treatmentParameters[] * @details \b Outputs: none * @param param ID of treatment parameter to get floating point value for @@ -432,7 +439,7 @@ * @brief * The getTreatmentParameterS32DefaultValue function gets the defaultvalue * of a given signed integer treatment parameter. - * @details \b Inputs: treatmentParameters[] + * @details \b Inputs: TREAT_PARAMS_PROPERTIES[] * @details \b Outputs: none * @param param ID of treatment parameter to get signed integer default value for * @return default value of given signed integer treatment parameter @@ -446,8 +453,10 @@ * @brief * The validateAndSetTreatmentParameters function validates received * treatment parameters. + * @details \b Message \b Sent: MSG_ID_TD_RESP_TREATMENT_PARAMS_TO_VALIDATE + * @details \b Message \b Sent: MSG_ID_TD_TREATMENT_PARAM_RANGES if params are valid * @details \b Inputs: none - * @details \b Outputs: stagedParams[], response sent + * @details \b Outputs: stagedParams[], validTreatParamsReceived * @param message set message from UI which includes the user set treatment * parameters record. * @return TRUE if received treatment parameters are valid, FALSE if not @@ -543,8 +552,9 @@ * @brief * The validateAndSetUFVolume function validates received ultrafiltration * volume treatment parameter. + * @details \b Message \b Sent: MSG_ID_TD_RESP_ULTRAFILTRATION_VOLUME_TO_VALIDATE * @details \b Inputs: none - * @details \b Outputs: + * @details \b Outputs: none * @param message set message from UI which includes the user set ultrafiltration * volume (in mL). * @return TRUE if received UF volume parameter is valid, FALSE if not @@ -721,8 +731,8 @@ * @brief * The handleWaitForUI2SendState function handles the wait for UI to send * treatment parameters state of treatment parameters mode. - * @details Inputs: - * @details Outputs: + * @details \b Inputs: treatmentCancelled, validTreatParamsReceived + * @details \b Outputs: treatmentCancelled, validTreatParamsReceived * @return current state (sub-mode) *************************************************************************/ static TD_TREATMENT_PARAMS_MODE_STATE_T handleWaitForUI2SendState( void ) @@ -749,8 +759,8 @@ * @brief * The handleWaitForUI2ConfirmState function handles the wait for UI to send * user confirmation state of treatment parameters mode. - * @details \b Inputs: - * @details \b Outputs: + * @details \b Inputs: treatParamsConfirmed, treatParamsRejected + * @details \b Outputs: treatParamsConfirmed, treatParamsRejected, origTreatmentParams * @return current state (sub-mode) *************************************************************************/ static TD_TREATMENT_PARAMS_MODE_STATE_T handleWaitForUI2ConfirmState( void ) @@ -822,6 +832,7 @@ * The sendTreatmentParamsResponse function responds to the treatment parameters * received from the UI. An over-all ok/rejected flag as well as individual reject * reason codes for each parameter are provided back to the UI. + * @details \b Message \b Sent: MSG_ID_TD_RESP_TREATMENT_PARAMS_TO_VALIDATE * @details \b Inputs : none * @details \b Outputs : Response to treatment parameters message constructed and sent. * @param rejected 1 if rejected, 0 if parameters ok @@ -841,6 +852,7 @@ * @brief * The isTreatmentParamInRange function determines whether a given treatment * parameter is in range. + * @details \b Alarm: ALARM_ID_TD_SOFTWARE_FAULT if given param is invalid * @details \b Inputs: treatParamsRanges[], hdInstitutionalRecord * @details \b Outputs: none * @param param ID of parameter to check range for @@ -947,7 +959,8 @@ * @brief * The getS32TreatmentParamLowerRangeLimit function returns the lower range * limit for a given signed integer treatment parameter. - * @details \b Inputs: none + * @details \b Alarm: ALARM_ID_TD_SOFTWARE_FAULT if given param is invalid + * @details \b Inputs: treatmentParameters[] * @details \b Outputs: none * @param param ID of parameter to get lower range limit for * @return lower range limit for given signed integer treatment parameter @@ -975,7 +988,8 @@ * @brief * The getS32TreatmentParamUpperRangeLimit function returns the upper range * limit for a given signed integer treatment parameter. - * @details \b Inputs: none + * @details \b Alarm: ALARM_ID_TD_SOFTWARE_FAULT if given param is invalid. + * @details \b Inputs: treatmentParameters[] * @details \b Outputs: none * @param param ID of parameter to get upper range limit for * @return upper range limit for given signed integer treatment parameter @@ -1003,7 +1017,8 @@ * @brief * The getU32TreatmentParamLowerRangeLimit function returns the lower range * limit for a given unsigned integer treatment parameter. - * @details \b Inputs: none + * @details \b Alarm: ALARM_ID_TD_SOFTWARE_FAULT if given param is invalid. + * @details \b Inputs: treatmentParameters[] * @details \b Outputs: none * @param param ID of parameter to get lower range limit for * @return lower range limit for given unsigned integer treatment parameter @@ -1031,7 +1046,8 @@ * @brief * The getU32TreatmentParamUpperRangeLimit function returns the upper range * limit for a given unsigned integer treatment parameter. - * @details \b Inputs: none + * @details \b Alarm: ALARM_ID_TD_SOFTWARE_FAULT if given param is invalid. + * @details \b Inputs: treatmentParameters[] * @details \b Outputs: none * @param param ID of parameter to get upper range limit for * @return upper range limit for given unsigned integer treatment parameter @@ -1059,7 +1075,8 @@ * @brief * The getF32TreatmentParamLowerRangeLimit function returns the lower range * limit for a given float treatment parameter. - * @details \b Inputs: none + * @details \b Alarm: ALARM_ID_TD_SOFTWARE_FAULT if given param is invalid. + * @details \b Inputs: treatmentParameters[] * @details \b Outputs: none * @param param ID of parameter to get lower range limit for * @return lower range limit for given float treatment parameter @@ -1087,7 +1104,8 @@ * @brief * The getF32TreatmentParamUpperRangeLimit function returns the upper range * limit for a given float treatment parameter. - * @details \b Inputs: none + * @details \b Alarm: ALARM_ID_TD_SOFTWARE_FAULT if given param is invalid. + * @details \b Inputs: treatmentParameters[] * @details \b Outputs: none * @param param ID of parameter to get lower range limit for * @return upper range limit for given float treatment parameter @@ -1115,7 +1133,7 @@ * @brief * The getS32DefaultTreatmentParamEdge function returns the min or max of * the default treatment parameters - * @details \b Inputs: TREAT_PARAMS_PROPERTIES + * @details \b Inputs: TREAT_PARAMS_PROPERTIES[] * @details \b Outputs: none * @param param ID of parameter * @param isMin to indicate whether minimum is needed for maximum @@ -1132,7 +1150,7 @@ * @brief * The getU32DefaultTreatmentParamEdge function returns the min or max of * the default treatment parameters - * @details \b Inputs: TREAT_PARAMS_PROPERTIES + * @details \b Inputs: TREAT_PARAMS_PROPERTIES[] * @details \b Outputs: none * @param param ID of parameter * @param isMin to indicate whether minimum is needed for maximum @@ -1149,7 +1167,7 @@ * @brief * The getF32DefaultTreatmentParamEdge function returns the min or max of * the default treatment parameters - * @details \b Inputs: TREAT_PARAMS_PROPERTIES + * @details \b Inputs: TREAT_PARAMS_PROPERTIES[] * @details \b Outputs: none * @param param ID of parameter * @param isMin to indicate whether minimum is needed for maximum