Index: firmware/App/Controllers/BloodFlow.h =================================================================== diff -u -r736cc5b56cc9c784ab1d8fc8687a73d190c35759 -r43b787035c0bced47c483e95ed0be21914dcac0f --- firmware/App/Controllers/BloodFlow.h (.../BloodFlow.h) (revision 736cc5b56cc9c784ab1d8fc8687a73d190c35759) +++ firmware/App/Controllers/BloodFlow.h (.../BloodFlow.h) (revision 43b787035c0bced47c483e95ed0be21914dcac0f) @@ -41,16 +41,16 @@ /// Payload record structure for a blood pump data message. typedef struct { - S32 setPoint; - F32 measFlow; - F32 measRotorSpd; - F32 measPumpSpd; - F32 measMCSpd; - F32 measMCCurr; - F32 pwmDC; - U32 rotorCount; - U32 presFlow; - U32 rotorHall; + S32 setPoint; ///< Set point. + F32 measFlow; ///< Measured flow in mL/min. + F32 measRotorSpd; ///< Measured rotor speed in RPM. + F32 measPumpSpd; ///< Measured pump speed in RPM. + F32 measMCSpd; ///< Measured motor speed in RPM. + F32 measMCCurr; ///< Measure motor current in Amps. + F32 pwmDC; ///< Duty cycle. + U32 rotorCount; ///< Rotor count. + U32 presFlow; ///< Blood flow in mL/min. + U32 rotorHall; ///< Rotor hall in counts. } BLOOD_PUMP_STATUS_PAYLOAD_T; // ********** public function prototypes ********** Index: firmware/App/Controllers/DialInFlow.h =================================================================== diff -u -r736cc5b56cc9c784ab1d8fc8687a73d190c35759 -r43b787035c0bced47c483e95ed0be21914dcac0f --- firmware/App/Controllers/DialInFlow.h (.../DialInFlow.h) (revision 736cc5b56cc9c784ab1d8fc8687a73d190c35759) +++ firmware/App/Controllers/DialInFlow.h (.../DialInFlow.h) (revision 43b787035c0bced47c483e95ed0be21914dcac0f) @@ -38,16 +38,16 @@ /// Payload record structure for a dialysate inlet pump data message. typedef struct { - S32 setPoint; - F32 measFlow; - F32 measRotorSpd; - F32 measPumpSpd; - F32 measMCSpd; - F32 measMCCurr; - F32 pwmDC; - U32 rotorCount; - U32 presFlow; - U32 rotorHall; + S32 setPoint; ///< Set point. + F32 measFlow; ///< Measured flow in mL/min. + F32 measRotorSpd; ///< Measured rotor speed in RPM. + F32 measPumpSpd; ///< Measured pump speed in RPM. + F32 measMCSpd; ///< Measured motor speed in RPM. + F32 measMCCurr; ///< Measure motor current in Amps. + F32 pwmDC; ///< Duty cycle. + U32 rotorCount; ///< Rotor count. + U32 presFlow; ///< Dialysate in flow in mL/min. + U32 rotorHall; ///< Rotor hall in counts. } DIALIN_PUMP_STATUS_PAYLOAD_T; // ********** public function prototypes ********** Index: firmware/App/Controllers/DialOutFlow.h =================================================================== diff -u -r736cc5b56cc9c784ab1d8fc8687a73d190c35759 -r43b787035c0bced47c483e95ed0be21914dcac0f --- firmware/App/Controllers/DialOutFlow.h (.../DialOutFlow.h) (revision 736cc5b56cc9c784ab1d8fc8687a73d190c35759) +++ firmware/App/Controllers/DialOutFlow.h (.../DialOutFlow.h) (revision 43b787035c0bced47c483e95ed0be21914dcac0f) @@ -35,7 +35,7 @@ #pragma pack(push, 1) /// Dialysate outlet pump broadcast record -typedef struct DialOutBroadcastingRecord +typedef struct { F32 refUFVolMl; ///< Reference ultrafiltration volume in mL. F32 measUFVolMl; ///< Total measured ultrafiltration volume in mL. Index: firmware/App/Controllers/SyringePump.h =================================================================== diff -u -r736cc5b56cc9c784ab1d8fc8687a73d190c35759 -r43b787035c0bced47c483e95ed0be21914dcac0f --- firmware/App/Controllers/SyringePump.h (.../SyringePump.h) (revision 736cc5b56cc9c784ab1d8fc8687a73d190c35759) +++ firmware/App/Controllers/SyringePump.h (.../SyringePump.h) (revision 43b787035c0bced47c483e95ed0be21914dcac0f) @@ -50,25 +50,25 @@ /// Payload record structure for the syringe pump operation request message. typedef struct { - U32 syringePumpOp; - F32 rate; - F32 volume; + U32 syringePumpOp; ///< Syringe pump operation. + F32 rate; ///< Syringe pump rate. + F32 volume; ///< Syringe pump volume. } SYRINGE_PUMP_OP_PAYLOAD_T; /// Payload record structure for the syringe pump data message. typedef struct { - U32 syringePumpState; - U32 heparinDeliveryState; - F32 syringePumpSetRate; - F32 syringePumpMeasRate; - S32 syringePumpPosition; - F32 syringePumpVolumeDelivered; - F32 syringePumpMeasHome; - F32 syringePumpMeasSwitch; - F32 syringePumpMeasForce; - F32 syringePumpSafetyVolume; - U32 syringePumpStatus; + U32 syringePumpState; ///< Syringe pump state. + U32 heparinDeliveryState; ///< Heparin delivery state. + F32 syringePumpSetRate; ///< Syringe pump set rate. + F32 syringePumpMeasRate; ///< Syringe pump measured rate. + S32 syringePumpPosition; ///< Syringe pump position. + F32 syringePumpVolumeDelivered; ///< Syringe pump volume delivered. + F32 syringePumpMeasHome; ///< Syringe pump measured home. + F32 syringePumpMeasSwitch; ///< Syringe pump measured switch. + F32 syringePumpMeasForce; ///< Syringe pump measured force. + F32 syringePumpSafetyVolume; ///< Syringe pump safety volume. + U32 syringePumpStatus; ///< Syringe pump status. } SYRINGE_PUMP_DATA_PAYLOAD_T; /// Heparin publish data structure Index: firmware/App/HDCommon.h =================================================================== diff -u -r6e705c755f1004c7e0982782b7cb578548cb525c -r43b787035c0bced47c483e95ed0be21914dcac0f --- firmware/App/HDCommon.h (.../HDCommon.h) (revision 6e705c755f1004c7e0982782b7cb578548cb525c) +++ firmware/App/HDCommon.h (.../HDCommon.h) (revision 43b787035c0bced47c483e95ed0be21914dcac0f) @@ -58,59 +58,59 @@ /// Payload record structure for an HD versions message. typedef struct { - U08 major; - U08 minor; - U08 micro; - U16 build; - U08 fpgaId; - U08 fpgaMajor; - U08 fpgaMinor; - U08 fpgaLab; - U32 compatibilityRev; + U08 major; ///< HD version major revision. + U08 minor; ///< HD version minor revision. + U08 micro; ///< HD version micro revision. + U16 build; ///< HD build version. + U08 fpgaId; ///< HD FPGA ID. + U08 fpgaMajor; ///< HD FPGA major revision. + U08 fpgaMinor; ///< HD FPGA minor revision. + U08 fpgaLab; ///< HD FPGA lab revision. + U32 compatibilityRev; ///< HD compatibility revision. } HD_VERSIONS_T; /// DG version struct. typedef struct { - U08 major; ///< DG version major revision - U08 minor; ///< DG version major revision - U08 micro; ///< DG version micro revision - U16 build; ///< DG build version - U08 fpgaId; ///< DG FPGA ID - U08 fpgaMajor; ///< DG FPGA major revision - U08 fpgaMinor; ///< DG FPGA minor revision - U08 fpgaLab; ///< DG FPGA lab revision - U32 compatibilityRev; ///< DG compatibility revision + U08 major; ///< DG version major revision. + U08 minor; ///< DG version major revision. + U08 micro; ///< DG version micro revision. + U16 build; ///< DG build version. + U08 fpgaId; ///< DG FPGA ID. + U08 fpgaMajor; ///< DG FPGA major revision. + U08 fpgaMinor; ///< DG FPGA minor revision. + U08 fpgaLab; ///< DG FPGA lab revision. + U32 compatibilityRev; ///< DG compatibility revision. } DG_VERSIONS_T; /// Record defining the fields in a UI version request message. typedef struct { - U08 major; ///< Major version for UI software - U08 minor; ///< Minor version for UI software - U08 micro; ///< Micro version for UI software - U16 build; ///< Build number for UI software - U32 compatibility; ///< Compatibility revision + U08 major; ///< Major version for UI software. + U08 minor; ///< Minor version for UI software. + U08 micro; ///< Micro version for UI software. + U16 build; ///< Build number for UI software. + U32 compatibility; ///< Compatibility revision. } UI_VERSIONS_T; /// Payload record structure for a peristaltic pump data message. typedef struct { - U32 setPoint; - F32 measFlow; - F32 measRotorSpd; - F32 measPumpSpd; - F32 measMCSpd; - F32 measMCCurr; - F32 pwmDC; + U32 setPoint; ///< Set point. + F32 measFlow; ///< Measured flow in mL/min. + F32 measRotorSpd; ///< Measured rotor speed in RPM. + F32 measPumpSpd; ///< Measured pump speed in RPM. + F32 measMCSpd; ///< Measured motor speed in RPM. + F32 measMCCurr; ///< Measured motor current in Amps. + F32 pwmDC; ///< Duty cycle. } PERISTALTIC_PUMP_STATUS_PAYLOAD_T; /// Payload record structure for a pump set point override message. typedef struct { - BOOL reset; - S32 setPt; - U32 ctrlMode; + BOOL reset; ///< Reset. + S32 setPt; ///< Set point. + U32 ctrlMode; ///< Control mode. } OVERRIDE_PUMP_SET_PT_PAYLOAD_T; #pragma pack(pop) Index: firmware/App/Modes/BloodPrime.h =================================================================== diff -u -r736cc5b56cc9c784ab1d8fc8687a73d190c35759 -r43b787035c0bced47c483e95ed0be21914dcac0f --- firmware/App/Modes/BloodPrime.h (.../BloodPrime.h) (revision 736cc5b56cc9c784ab1d8fc8687a73d190c35759) +++ firmware/App/Modes/BloodPrime.h (.../BloodPrime.h) (revision 43b787035c0bced47c483e95ed0be21914dcac0f) @@ -41,8 +41,8 @@ /// Payload record structure for a blood prime data broadcast message. typedef struct { - F32 targetBloodPrimeVolumeMl; - F32 deliveredBloodPrimeVolumeMl; + F32 targetBloodPrimeVolumeMl; ///< Target blood prime volume in mL. + F32 deliveredBloodPrimeVolumeMl; ///< Delivered blood prime volume in mL. } BLOOD_PRIME_DATA_PAYLOAD_T; // ********** public function prototypes ********** Index: firmware/App/Modes/Dialysis.h =================================================================== diff -u -r736cc5b56cc9c784ab1d8fc8687a73d190c35759 -r43b787035c0bced47c483e95ed0be21914dcac0f --- firmware/App/Modes/Dialysis.h (.../Dialysis.h) (revision 736cc5b56cc9c784ab1d8fc8687a73d190c35759) +++ firmware/App/Modes/Dialysis.h (.../Dialysis.h) (revision 43b787035c0bced47c483e95ed0be21914dcac0f) @@ -41,9 +41,9 @@ /// Payload record structure for a saline bolus data broadcast message. typedef struct { - U32 tgtSalineVolumeMl; - F32 cumSalineVolumeMl; - F32 bolSalineVolumeMl; + U32 tgtSalineVolumeMl; ///< Target saline volume in mL. + F32 cumSalineVolumeMl; ///< Cumulative saline volume in mL. + F32 bolSalineVolumeMl; ///< Bolus saline volume in mL. } SALINE_BOLUS_DATA_PAYLOAD_T; #pragma pack(pop) Index: firmware/App/Modes/ModeTreatment.h =================================================================== diff -u -r736cc5b56cc9c784ab1d8fc8687a73d190c35759 -r43b787035c0bced47c483e95ed0be21914dcac0f --- firmware/App/Modes/ModeTreatment.h (.../ModeTreatment.h) (revision 736cc5b56cc9c784ab1d8fc8687a73d190c35759) +++ firmware/App/Modes/ModeTreatment.h (.../ModeTreatment.h) (revision 43b787035c0bced47c483e95ed0be21914dcac0f) @@ -36,59 +36,59 @@ /// Payload record structure for a treatment time status message. typedef struct { - U32 treatmentTimePrescribedinSec; - U32 treatmentTimeElapsedinSec; - U32 treatmentTimeRemaininginSec; + U32 treatmentTimePrescribedinSec; ///< Treatment time prescribed in seconds. + U32 treatmentTimeElapsedinSec; ///< Treatment time elapsed in seconds. + U32 treatmentTimeRemaininginSec; ///< Treatment time remaining in seconds. } TREATMENT_TIME_DATA_T; /// Payload record structure for a treatment state message. typedef struct { - U32 treatmentSubMode; - U32 uFState; - U32 salineBolusState; - U32 heparinState; - U32 rinsebackState; - U32 txRecircState; - U32 bldPrimeState; - U32 txEndState; - U32 txStopState; - U32 dialysisState; + U32 treatmentSubMode; ///< Treatment submode. + U32 uFState; ///< Ultrafiltration state. + U32 salineBolusState; ///< Saline bolus state. + U32 heparinState; ///< Heparin state. + U32 rinsebackState; ///< Rinse back state. + U32 txRecircState; ///< Treatment recirc state. + U32 bldPrimeState; ///< Blood prime state. + U32 txEndState; ///< Treatment end state. + U32 txStopState; ///< Treatment stop state. + U32 dialysisState; ///< Dialysis state. } TREATMENT_STATE_DATA_T; /// Payload record structure for an ultrafiltration volume change confirmation message. typedef struct { - F32 volume_mL; - U32 adjustType; + F32 volume_mL; /// Volume in mL. + U32 adjustType; ///< Adjust type. } UF_SETTINGS_CHANGE_CONFIRMATION_PAYLOAD_T; /// Payload record structure for the in-line pressure limits change request. typedef struct { - S32 artPresLimitWindowmmHg; - S32 venPresLimitWindowmmHg; - S32 venPresLimitAsymmetricmmHg; + S32 artPresLimitWindowmmHg; ///< Arterial pressure limit window in mmHg. + S32 venPresLimitWindowmmHg; ///< Venous pressure limit window in mmHg. + S32 venPresLimitAsymmetricmmHg; ///< Venous pressure limit asymmetric in mmHg. } PRESSURE_LIMIT_CHANGE_REQUEST_T; /// Payload record structure for the in-line pressure limits change response. typedef struct { - BOOL accepted; - U32 rejReasonCode; - S32 artPresLimitWindowmmHg; - S32 venPresLimitWindowmmHg; - S32 venPresLimitAsymmetricmmHg; + BOOL accepted; ///< Accepted. + U32 rejReasonCode; ///< Rejection reason code number. + S32 artPresLimitWindowmmHg; ///< Arterial pressure limit window in mmHg. + S32 venPresLimitWindowmmHg; ///< Venous pressure limit window in mmHg. + S32 venPresLimitAsymmetricmmHg; ///< Venous pressure limit asymmetric in mmHg. } PRESSURE_LIMIT_CHANGE_RESPONSE_T; /// Payload record structure for the treatment log 30 minutes periodic data. typedef struct { - F32 avgBloodFlowRate; - F32 avgDialysateFlowRate; - F32 avgUFRate; - F32 avgArterialPressure; - F32 avgVenousPressure; + F32 avgBloodFlowRate; ///< Average blood flow rate in mL/min. + F32 avgDialysateFlowRate; ///< Average dialysate flow rate in mL/min. + F32 avgUFRate; ///< Average ultrafiltration rate. + F32 avgArterialPressure; ///< Average arterial pressure in mmHg. + F32 avgVenousPressure; ///< Average venous pressure in mmHg. } TREATMENT_LOG_DATA_PERIODIC_T; /// Maximum time in this mode before blood sitting alarm given (in general task intervals). Index: firmware/App/Modes/Rinseback.h =================================================================== diff -u -r736cc5b56cc9c784ab1d8fc8687a73d190c35759 -r43b787035c0bced47c483e95ed0be21914dcac0f --- firmware/App/Modes/Rinseback.h (.../Rinseback.h) (revision 736cc5b56cc9c784ab1d8fc8687a73d190c35759) +++ firmware/App/Modes/Rinseback.h (.../Rinseback.h) (revision 43b787035c0bced47c483e95ed0be21914dcac0f) @@ -39,12 +39,12 @@ /// Payload record structure for a rinseback data broadcast message. typedef struct { - F32 targetRinsebackVolumeMl; - F32 deliveredRinsebackVolumeMl; - U32 rinsebackFlowRateMlMin; - U32 timeout; - U32 countdown; - BOOL isCompleted; + F32 targetRinsebackVolumeMl; ///< Target rinse back volume in mL. + F32 deliveredRinsebackVolumeMl; ///< Delivered rinse back volume in mL. + U32 rinsebackFlowRateMlMin; ///< Rinse back flow rate in mL/min. + U32 timeout; ///< Timeout in milliseconds. + U32 countdown; ///< Countdown. + BOOL isCompleted; ///< Is completed. } RINSEBACK_DATA_PAYLOAD_T; #pragma pack(pop) Index: firmware/App/Services/Reservoirs.h =================================================================== diff -u -r736cc5b56cc9c784ab1d8fc8687a73d190c35759 -r43b787035c0bced47c483e95ed0be21914dcac0f --- firmware/App/Services/Reservoirs.h (.../Reservoirs.h) (revision 736cc5b56cc9c784ab1d8fc8687a73d190c35759) +++ firmware/App/Services/Reservoirs.h (.../Reservoirs.h) (revision 43b787035c0bced47c483e95ed0be21914dcac0f) @@ -40,12 +40,12 @@ { U32 reservoirsExecState; ///< Reservoirs exec state. F32 activeReservoirUFVolML; ///< Active reservoir ultrafiltration volume milliliters. - F32 activeReservoirVolSpentML; - F32 dilLevelPct; - F32 recircLevelPct; - U32 timeDepletionMS; - U32 timeWaitFillMS; - F32 tempRemoveTargetFillFlow; + F32 activeReservoirVolSpentML; ///< Active reservoir volume spent in milliliters. + F32 dilLevelPct; ///< Dilution level in percent. + F32 recircLevelPct; ///< Recirculation level in percent. + U32 timeDepletionMS; ///< Time depletion in milliseconds. + U32 timeWaitFillMS; ///< Time wait to fill in milliseconds. + F32 tempRemoveTargetFillFlow; ///< Temperature target fill flow in C. } RESERVOIRS_MANAGEMENT_DATA_T; // ********** public function prototypes ********** Index: firmware/App/Services/SystemComm.c =================================================================== diff -u -r5c0b64ff51d9290431d94bfc6aced78a2d5370be -r43b787035c0bced47c483e95ed0be21914dcac0f --- firmware/App/Services/SystemComm.c (.../SystemComm.c) (revision 5c0b64ff51d9290431d94bfc6aced78a2d5370be) +++ firmware/App/Services/SystemComm.c (.../SystemComm.c) (revision 43b787035c0bced47c483e95ed0be21914dcac0f) @@ -68,13 +68,13 @@ /// Record for transmitted message that is pending acknowledgment from receiver. typedef struct { - BOOL used; - U16 seqNo; - U16 retries; - U32 timeStamp; - COMM_BUFFER_T channel; - U32 msgSize; - U08 msg[ MAX_ACK_MSG_SIZE ]; + BOOL used; ///< Used. + U16 seqNo; ///< Message sequence number. + U16 retries; ///< Number of retries. + U32 timeStamp; ///< Time stamp. + COMM_BUFFER_T channel; ///< Channel ID. + U32 msgSize; ///< Message size. + U08 msg[ MAX_ACK_MSG_SIZE ]; ///< Message. } PENDING_ACK_RECORD_T; #pragma pack(pop) Index: firmware/App/Services/SystemCommMessages.c =================================================================== diff -u -r5c0b64ff51d9290431d94bfc6aced78a2d5370be -r43b787035c0bced47c483e95ed0be21914dcac0f --- firmware/App/Services/SystemCommMessages.c (.../SystemCommMessages.c) (revision 5c0b64ff51d9290431d94bfc6aced78a2d5370be) +++ firmware/App/Services/SystemCommMessages.c (.../SystemCommMessages.c) (revision 43b787035c0bced47c483e95ed0be21914dcac0f) @@ -61,7 +61,7 @@ /// Payload record structure for block message transmission request. typedef struct { - U16 blockedMessages[ MAX_MSGS_BLOCKED_FOR_XMIT ]; + U16 blockedMessages[ MAX_MSGS_BLOCKED_FOR_XMIT ]; ///< Blocked messages. } BLOCKED_MSGS_DATA_T; #pragma pack(pop)