linux/ipcore/PtmeConfig.h

@@ -55,6 +55,13 @@ class PtmeConfig : public SystemObject {
    */
   ReturnValue_t configTxManipulator(bool enable);
 
+  /**
+   * Enable the bat priority bit in the PTME wrapper component.
+   * Please note that a reset of the PTME is still required as specified in the documentation.
+   * This is done by a higher level component.
+   * @param enable
+   * @return
+   */
   ReturnValue_t enableBatPriorityBit(bool enable);
 
  private:

mission/tmtc/CcsdsIpCoreHandler.h

@@ -176,6 +176,12 @@ class CcsdsIpCoreHandler : public SystemObject,
    */
   void disableTransmit();
 
+  /**
+   * The following set of functions configure the mode of the PTME bandwith allocation table (BAT) module.
+   * This consists of the following 2 steps:
+   *   1. Update the BAT priority bit in the PTME wrapper
+   *   2. Reset the PTME as specified in the datasheet.
+   */
   void enablePrioritySelectMode();
   void disablePrioritySelectMode();
   void updateBatPriorityFromParam();