Utils.hpp

Go to the documentation of this file.

// ======================================================================
// \title  Utils.hpp
// \brief  CFDP utilities header
//
// This file is a port of CFDP utility functions from the following files
// from the NASA Core Flight System (cFS) CFDP (CF) Application, version 3.0.0,
// adapted for use within the F-Prime (F') framework:
// - cf_utils.h (CFDP utility function declarations)
//
// CFDP utils header file
//
// ======================================================================
//
// NASA Docket No. GSC-18,447-1
//
// Copyright (c) 2019 United States Government as represented by the
// Administrator of the National Aeronautics and Space Administration.
// All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may
// not use this file except in compliance with the License. You may obtain
// a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// ======================================================================

#ifndef CFDP_UTILS_HPP
#define CFDP_UTILS_HPP

#include <Fw/Types/Assert.hpp>

#include <Svc/Ccsds/CfdpManager/Engine.hpp>

namespace Svc {
namespace Ccsds {
namespace Cfdp {

struct CfdpTraverseTransSeqArg {
    TransactionSeq transaction_sequence_number;
    EntityId src_eid;
    Transaction* txn; 
};

struct CfdpTraverseAllArg {
    CfdpTraverseAllTransactionsFunc fn; 
    void* context;                      
    I32 counter;                        
};

struct CfdpTraversePriorityArg {
    Transaction* txn; 
    U8 priority;      
};

/************************************************************************/
CListTraverseStatus FindTransactionBySequenceNumberImpl(CListNode* node, void* context);

/************************************************************************/
CListTraverseStatus PrioSearch(CListNode* node, void* context);

/************************************************************************/
ConditionCode TxnStatusToConditionCode(TxnStatus txn_stat);

/************************************************************************/
bool TxnStatusIsError(TxnStatus txn_stat);

/************************************************************************/
AckTxnStatus GetTxnStatus(Transaction* txn);

}  // namespace Cfdp
}  // namespace Ccsds
}  // namespace Svc

#endif /* !CFDP_UTILS_HPP */