/*------------------------------------------------------------------------------

--  Solar Orbiter's Low Frequency Receiver Flight Software (LFR FSW),

--  This file is a part of the LFR FSW

--  Copyright (C) 2012-2018, Plasma Physics Laboratory - CNRS

--

--  This program is free software; you can redistribute it and/or modify

--  it under the terms of the GNU General Public License as published by

--  the Free Software Foundation; either version 2 of the License, or

--  (at your option) any later version.

--

--  This program is distributed in the hope that it will be useful,

--  but WITHOUT ANY WARRANTY; without even the implied warranty of

--  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

--  GNU General Public License for more details.

--

--  You should have received a copy of the GNU General Public License

--  along with this program; if not, write to the Free Software

--  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

-------------------------------------------------------------------------------*/

/*--                  Author : Paul Leroy

--                   Contact : Alexis Jeandet

--                      Mail : alexis.jeandet@lpp.polytechnique.fr

----------------------------------------------------------------------------*/

/** Functions to send TM packets related to TC parsing and execution.

 *

 * @file

 * @author P. LEROY

 *

 * A group of functions to send appropriate TM packets after parsing and execution:

 * - TM_LFR_TC_EXE_SUCCESS

 * - TM_LFR_TC_EXE_INCONSISTENT

 * - TM_LFR_TC_EXE_NOT_EXECUTABLE

 * - TM_LFR_TC_EXE_NOT_IMPLEMENTED

 * - TM_LFR_TC_EXE_ERROR

 * - TM_LFR_TC_EXE_CORRUPTED

 *

 */

#include "tm_lfr_tc_exe.h"

{

    /** This function sends a TM_LFR_TC_EXE_SUCCESS packet in the dedicated RTEMS message queue.

     *

     * @param TC points to the TeleCommand packet that is being processed

     * @param queue_id is the id of the queue which handles TM

     *

     * @return RTEMS directive status code:

     * - RTEMS_SUCCESSFUL - message sent successfully

     * - RTEMS_INVALID_ID - invalid queue id

     * - RTEMS_INVALID_SIZE - invalid message size

     * - RTEMS_INVALID_ADDRESS - buffer is NULL

     * - RTEMS_UNSATISFIED - out of message buffers

     * - RTEMS_TOO_MANY - queue s limit has been reached

     *

     */

    rtems_status_code status;

    Packet_TM_LFR_TC_EXE_SUCCESS_t TM;

    unsigned char messageSize;

    // PACKET HEADER

    // DATA FIELD HEADER

    //

    // SEND DATA

    if (status != RTEMS_SUCCESSFUL) {

        PRINTF("in send_tm_lfr_tc_exe_success *** ERR\n")

    }

    // UPDATE HK FIELDS

}

                                    unsigned char byte_position, unsigned char rcv_value )

{

    /** This function sends a TM_LFR_TC_EXE_INCONSISTENT packet in the dedicated RTEMS message queue.

     *

     * @param TC points to the TeleCommand packet that is being processed

     * @param queue_id is the id of the queue which handles TM

     * @param byte_position is the byte position of the MSB of the parameter that has been seen as inconsistent

     * @param rcv_value  is the value of the LSB of the parameter that has been detected as inconsistent

     *

     * @return RTEMS directive status code:

     * - RTEMS_SUCCESSFUL - message sent successfully

     * - RTEMS_INVALID_ID - invalid queue id

     * - RTEMS_INVALID_SIZE - invalid message size

     * - RTEMS_INVALID_ADDRESS - buffer is NULL

     * - RTEMS_UNSATISFIED - out of message buffers

     * - RTEMS_TOO_MANY - queue s limit has been reached

     *

     */

    rtems_status_code status;

    Packet_TM_LFR_TC_EXE_INCONSISTENT_t TM;

    unsigned char messageSize;

    // PACKET HEADER

    // DATA FIELD HEADER

    //

    // SEND DATA

    if (status != RTEMS_SUCCESSFUL) {

        PRINTF("in send_tm_lfr_tc_exe_inconsistent *** ERR\n")

    }

    // UPDATE HK FIELDS

}

{

    /** This function sends a TM_LFR_TC_EXE_NOT_EXECUTABLE packet in the dedicated RTEMS message queue.

     *

     * @param TC points to the TeleCommand packet that is being processed

     * @param queue_id is the id of the queue which handles TM

     *

     * @return RTEMS directive status code:

     * - RTEMS_SUCCESSFUL - message sent successfully

     * - RTEMS_INVALID_ID - invalid queue id

     * - RTEMS_INVALID_SIZE - invalid message size

     * - RTEMS_INVALID_ADDRESS - buffer is NULL

     * - RTEMS_UNSATISFIED - out of message buffers

     * - RTEMS_TOO_MANY - queue s limit has been reached

     *

     */

    rtems_status_code status;

    Packet_TM_LFR_TC_EXE_NOT_EXECUTABLE_t TM;

    unsigned char messageSize;

    // PACKET HEADER

    // DATA FIELD HEADER

    //

    // SEND DATA

    if (status != RTEMS_SUCCESSFUL) {

        PRINTF("in send_tm_lfr_tc_exe_not_executable *** ERR\n")

    }

    // UPDATE HK FIELDS

}

#ifdef DENABLE_DEAD_CODE

int send_tm_lfr_tc_exe_not_implemented( ccsdsTelecommandPacket_t *TC, rtems_id queue_id, unsigned char *time )

{

    /** This function sends a TM_LFR_TC_EXE_NOT_IMPLEMENTED packet in the dedicated RTEMS message queue.

     *

     * @param TC points to the TeleCommand packet that is being processed

     * @param queue_id is the id of the queue which handles TM

     *

     * @return RTEMS directive status code:

     * - RTEMS_SUCCESSFUL - message sent successfully

     * - RTEMS_INVALID_ID - invalid queue id

     * - RTEMS_INVALID_SIZE - invalid message size

     * - RTEMS_INVALID_ADDRESS - buffer is NULL

     * - RTEMS_UNSATISFIED - out of message buffers

     * - RTEMS_TOO_MANY - queue s limit has been reached

     *

     */

    rtems_status_code status;

    Packet_TM_LFR_TC_EXE_NOT_IMPLEMENTED_t TM;

    unsigned char messageSize;

    TM.targetLogicalAddress = CCSDS_DESTINATION_ID;

    TM.protocolIdentifier = CCSDS_PROTOCOLE_ID;

    TM.reserved = DEFAULT_RESERVED;

    TM.userApplication = CCSDS_USER_APP;

    // PACKET HEADER

    TM.packetID[0] = (unsigned char) (APID_TM_TC_EXE >> SHIFT_1_BYTE);

    TM.packetID[1] = (unsigned char) (APID_TM_TC_EXE     );

    increment_seq_counter_destination_id( TM.packetSequenceControl, TC->sourceID );

    TM.packetLength[0] = (unsigned char) (PACKET_LENGTH_TC_EXE_NOT_IMPLEMENTED >> SHIFT_1_BYTE);

    TM.packetLength[1] = (unsigned char) (PACKET_LENGTH_TC_EXE_NOT_IMPLEMENTED     );

    // DATA FIELD HEADER

    TM.spare1_pusVersion_spare2 = DEFAULT_SPARE1_PUSVERSION_SPARE2;

    TM.serviceType = TM_TYPE_TC_EXE;

    TM.serviceSubType = TM_SUBTYPE_EXE_NOK;

    TM.destinationID = TC->sourceID;    // default destination id

    TM.time[BYTE_0] = (unsigned char) (time_management_regs->coarse_time >> SHIFT_3_BYTES);

    TM.time[BYTE_1] = (unsigned char) (time_management_regs->coarse_time >> SHIFT_2_BYTES);

    TM.time[BYTE_2] = (unsigned char) (time_management_regs->coarse_time >> SHIFT_1_BYTE);

    TM.time[BYTE_3] = (unsigned char) (time_management_regs->coarse_time);

    TM.time[BYTE_4] = (unsigned char) (time_management_regs->fine_time >> SHIFT_1_BYTE);

    TM.time[BYTE_5] = (unsigned char) (time_management_regs->fine_time);

    //

    TM.tc_failure_code[0] = (char) (FUNCT_NOT_IMPL >> SHIFT_1_BYTE);

    TM.tc_failure_code[1] = (char) (FUNCT_NOT_IMPL     );

    TM.telecommand_pkt_id[0] = TC->packetID[0];

    TM.telecommand_pkt_id[1] = TC->packetID[1];

    TM.pkt_seq_control[0] = TC->packetSequenceControl[0];

    TM.pkt_seq_control[1] = TC->packetSequenceControl[1];

    TM.tc_service = TC->serviceType;      // type of the rejected TC

    TM.tc_subtype = TC->serviceSubType;   // subtype of the rejected TC

    messageSize = PACKET_LENGTH_TC_EXE_NOT_IMPLEMENTED + CCSDS_TC_TM_PACKET_OFFSET + CCSDS_PROTOCOLE_EXTRA_BYTES;

    // SEND DATA

    status =  rtems_message_queue_send( queue_id, &TM, messageSize);

    if (status != RTEMS_SUCCESSFUL) {

        PRINTF("in send_tm_lfr_tc_exe_not_implemented *** ERR\n")

    }

    // UPDATE HK FIELDS

    update_last_TC_rej( TC, TM.time );

    return status;

}

#endif

{

    /** This function sends a TM_LFR_TC_EXE_ERROR packet in the dedicated RTEMS message queue.

     *

     * @param TC points to the TeleCommand packet that is being processed

     * @param queue_id is the id of the queue which handles TM

     *

     * @return RTEMS directive status code:

     * - RTEMS_SUCCESSFUL - message sent successfully

     * - RTEMS_INVALID_ID - invalid queue id

     * - RTEMS_INVALID_SIZE - invalid message size

     * - RTEMS_INVALID_ADDRESS - buffer is NULL

     * - RTEMS_UNSATISFIED - out of message buffers

     * - RTEMS_TOO_MANY - queue s limit has been reached

     *

     */

    rtems_status_code status;

    Packet_TM_LFR_TC_EXE_ERROR_t TM;

    unsigned char messageSize;

    // PACKET HEADER

    // DATA FIELD HEADER

    //

    // SEND DATA

    if (status != RTEMS_SUCCESSFUL) {

        PRINTF("in send_tm_lfr_tc_exe_error *** ERR\n")

    }

    // UPDATE HK FIELDS

}

                                 unsigned char *computed_CRC, unsigned char *currentTC_LEN_RCV,

                                 unsigned char destinationID )

{

    /** This function sends a TM_LFR_TC_EXE_CORRUPTED packet in the dedicated RTEMS message queue.

     *

     * @param TC points to the TeleCommand packet that is being processed

     * @param queue_id is the id of the queue which handles TM

     * @param computed_CRC points to a buffer of two bytes containing the CRC computed during the parsing of the TeleCommand

     * @param currentTC_LEN_RCV points to a buffer of two bytes containing a packet size field computed on the received data

     *

     * @return RTEMS directive status code:

     * - RTEMS_SUCCESSFUL - message sent successfully

     * - RTEMS_INVALID_ID - invalid queue id

     * - RTEMS_INVALID_SIZE - invalid message size

     * - RTEMS_INVALID_ADDRESS - buffer is NULL

     * - RTEMS_UNSATISFIED - out of message buffers

     * - RTEMS_TOO_MANY - queue s limit has been reached

     *

     */

    rtems_status_code status;

    Packet_TM_LFR_TC_EXE_CORRUPTED_t TM;

    unsigned char messageSize;

    unsigned int packetLength;

    unsigned int estimatedPacketLength;

    unsigned char *packetDataField;

    // PACKET HEADER

    // DATA FIELD HEADER

    //

    // SEND DATA

    if (status != RTEMS_SUCCESSFUL) {

        PRINTF("in send_tm_lfr_tc_exe_error *** ERR\n")

    }

    // UPDATE HK FIELDS

}

{

    /** This function increment the packet sequence control parameter of a TC, depending on its destination ID.

     *

     * @param packet_sequence_control points to the packet sequence control which will be incremented

     * @param destination_id is the destination ID of the TM, there is one counter by destination ID

     *

     * If the destination ID is not known, a dedicated counter is incremented.

     *

     */

    unsigned short sequence_cnt;

    unsigned short segmentation_grouping_flag;

    unsigned short new_packet_sequence_control;

    unsigned char i;

    {

    case SID_TC_GROUND:

    case SID_TC_MISSION_TIMELINE:

    case SID_TC_TC_SEQUENCES:

    case SID_TC_RECOVERY_ACTION_CMD:

    case SID_TC_BACKUP_MISSION_TIMELINE:

    case SID_TC_DIRECT_CMD:

    case SID_TC_SPARE_GRD_SRC1:

    case SID_TC_SPARE_GRD_SRC2:

    case SID_TC_OBCP:

    case SID_TC_SYSTEM_CONTROL:

    case SID_TC_AOCS:

    case SID_TC_RPW_INTERNAL:

    default:

        break;

    }

    // increment the sequence counter

    {

    }

    else

    {

    }