/**************************************************************************
*
* Copyright (c) 2026-2027 Diality Inc. - All Rights Reserved.
*
* THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN
* WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER.
*
* @file    NVJobQ.h
*
* @author  (original)  Arpita Srivastava
* @date    (original)  31-Mar-2026
*
***************************************************************************/

#ifndef _NV_JOB_Q_H_
#define _NV_JOB_Q_H_

#include "Common.h"
#include "DDDefs.h"
#include "NVDriver.h"

/**
 *  @defgroup NVJobQ NVJobQ
 *  @brief This module manages the NV record job queue. It provides interfaces
 *  to enqueue, dequeue, and monitor record operations such as read,
 *  write, and erase. It also maintains queue state, availability, and
 *  current job tracking for NV data processing.
 *
 *  @addtogroup NVJobQ
 *  @{
 */

// ********** public definitions **********

#define MAX_NUM_OF_RECORD_IN_A_SECTOR            2                                                           ///< Maximum number of records stored in one sector
#define MIN_JOBS_NEEDED_TO_WRITE_A_RECORD        ( MAX_NUM_OF_RECORD_IN_A_SECTOR * 2 )                       ///< Minimum queue jobs to erase and write one record
#define MIN_JOBS_NEEDED_TO_WRITE_ALL_RECORDS     ( NUM_OF_NVM_RECORD_TYPES * 2 )                             ///< Minimum queue jobs to erase and write all records
#define MIN_JOBS_NEEDED_TO_READ_ALL_RECORDS      ( NUM_OF_NVM_RECORD_TYPES )                                 ///< Minimum queue jobs to read all records

/// NVM records read status
typedef enum NVM_NV_Records_Read_Status
{
    NVM_RECORDS_NOT_STARTED = 0,                                                ///< NVM records not started.
    NVM_RECORDS_QUEUED,                                                         ///< NVM records queued.
    NVM_RECORDS_READ,                                                           ///< NVM records read.
    NVM_RECORDS_CRC_CHECKED,                                                    ///< NVM records CRC checked.
    NUM_OF_NVM_READ_RECORDS_STATES,                                             ///< Number of NVM read records states.
} NVM_RECORDS_READ_STATUS_T;

// ********** public function prototypes **********

void initNVJobQ( void );
// Record operations queue functions
void enqueueRecordJob( NVM_OPERATION_T ops, NVM_RECORD_TYPE_T job );
void dequeueRecordJob( void );
BOOL isRecordQueueEmpty( void );
BOOL isRecordQueueFull( void );
U32  getAvailableRecordQueueCount( void );
BOOL enqueueEraseAndWriteSector( NVM_RECORD_TYPE_T job );
BOOL enqueuewriteAllRecords( void );
BOOL enqueueReadAllRecords( void );
void updateRecordReadStatus( NVM_RECORDS_READ_STATUS_T status );
PROCESS_RECORD_JOB_T getCurrentProcessRecordJob ( void );

/**@}*/

#endif /* _NV_JOB_Q_H_ */