mpi_types.h

Go to the documentation of this file.

/*
 * mpi_types.h
 *
 * Created on: Jun 14, 2024
 * Author: Vaibhav Kapoor
 */
 
#ifndef INCLUDE_GUARD__MPI_TYPES_H
#define INCLUDE_GUARD__MPI_TYPES_H
#include <stdint.h>

typedef enum {
    MPI_RX_MODE_COMMAND_MODE,               // MPI is in command mode
    MPI_RX_MODE_SENSING_MODE,               // MPI is science data is being collected mode
    MPI_RX_MODE_NOT_LISTENING_TO_MPI        // MPI is recording science data but it is not being collected mode
} MPI_rx_mode_t;
 
typedef enum {
    MPI_MEMORY_WRITE_STATUS_AWAITING_WRITE, // MPI buffer is waiting to be fully wrote to memory
    MPI_MEMORY_WRITE_STATUS_READY_TO_FILL,  // MPI buffer is ready to be wrote to
} MPI_buffer_state_enum_t;

typedef enum {
    MPI_TRANSCEIVER_MODE_INACTIVE,
    MPI_TRANSCEIVER_MODE_MOSI,
    MPI_TRANSCEIVER_MODE_MISO,
    MPI_TRANSCEIVER_MODE_DUPLEX
} MPI_transceiver_state_enum_t;

typedef struct
{
    uint8_t sync_byte1;                      // First synchronization byte
    uint8_t sync_byte2;                      // Second synchronization byte
    uint8_t sync_byte3;                      // Third synchronization byte
    uint8_t sync_byte4;                      // Fourth synchronization byte
    uint16_t frame_counter;                  // Frame counter for the data frame
    int16_t board_temperature;               // Current board temperature
    uint8_t firmware_version;                // Firmware version of the MPI unit
    uint8_t mpi_unit_id;                     // ID of the MPI unit
    uint16_t detector_status;                // Current status of the detector
    uint16_t inner_dome_voltage_setting;     // Voltage setting for the inner dome
    uint8_t spib_reserved;                   // Reserved field
    uint8_t inner_dome_scan_index;           // Index for inner dome scanning
    uint16_t faceplate_voltage_setting;      // Voltage setting for the faceplate
    uint16_t faceplate_voltage_adc_reading;  // ADC reading for faceplate voltage
    uint16_t inner_dome_voltage_adc_reading; // ADC reading for inner dome voltage
    uint16_t pixels[67];                     // Array of 67 image pixels    (Not a typo: It is actually 67!)
    uint16_t cyclic_redundancy_check;        // CRC for data integrity check
} MPI_dataframe_t;
 
#endif // INCLUDE_GUARD__MPI_TYPES_H