vis-spi-out.c

Go to the documentation of this file.

 
// Pick a sensor
#ifdef LIS // <------------- $ make sensor=LIS
#include "LisConfigs.h"
#endif
#ifdef S13131 // <---------- $ make sensor=S13131
#endif
 
#include "Hardware.h" // Hardware i/o definitions
#include "StatusCodes.h" // Python-to-Firmware communication status codes
#include "BiColorLed.h"
#include "Spi.h"
#include "SpiSlave.h"
#include "UartSpi.h"
#ifdef LIS
#include "Lis.h"
#endif
#ifdef S13131
#include "S13131.h"
#endif
#include <stdlib.h> // defines NULL
#include "Queue.h" // SPI communication queue
 
#include "VisCmd.h"
 
volatile Queue_s * SpiFifo;
#define max_length_of_queue 24 // bytes
volatile uint8_t spi_rx_buffer[max_length_of_queue];
 
static void setup(void);
static void loop(void);
static void setup_IndicatorLEDs(void);
static void setup_SpiCommunication(void);
static void setup_DetectorReadout(void);
int main()
{
    setup();
    while(1) loop();
}
void setup(void)
{
    setup_IndicatorLEDs();
    setup_SpiCommunication();
    setup_DetectorReadout();
}
void loop(void)
{
    // Catch errors
    if (QueueIsFull(SpiFifo)) // 7 cycles
    {
        // TODO: replace with an error handler
        BiColorLedRed(led_0);
    }
    // Idle until a command is received
    while (QueueIsEmpty(SpiFifo)); // 5 cycles
    // Execute the command.
    // BUSY
    BiColorLedOff(led_0);
    switch(QueuePop(SpiFifo))
    {
        default: SpiSlaveTxByte(ERROR); break;
        case  0: NullCommand(); break;
        case  3: GetSensorLED(); break;
        case  4: SetSensorLED(); break;
#ifdef LIS
        case  7: GetSensorConfig(); break;
        case  8: SetSensorConfig(); break;
#endif
        case  9: GetExposure(); break;
        case 10: SetExposure(); break;
        case 11: CaptureFrame(); break;
        case 12: AutoExposure(); break;
        case 13: GetAutoExposeConfig(); break;
        case 14: SetAutoExposeConfig(); break;
        case 15: GetSensorHash(); break;
        /* default: ReplyCommandInvalid(); break; */
        // ---Expected Assembly---
        // Context:
        // 1. 0x19e is the start of loop()
        // 2. QueuePop puts `cmd` byte in r24
        // Handle case 0:
        //  1de:    and r24, r24; `cmd` is in r24
        //  1e0:    breq    .-68        ; 0x19e <main+0xf8>
        // Handle case 8:
        //  1e2:    cpi r24, 0x08   ; 8
        //  1e4:    breq    .+34        ; 0x208 <main+0x162>
        // Default case:
        //  1e6:    out 0x2e, r19   ; 46
        // Total number of cycles: 7
        // Total number of instructions: 5
    }
    // DONE
    BiColorLedOn(led_0);
}
ISR(SPI_STC_vect) // Serial Transfer Complete
{
    QueuePush(SpiFifo, *Spi_SPDR);
}
void setup_IndicatorLEDs(void)
{
    BiColorLedOn(led_0); // sbi 0x07, 0
    BiColorLedOn(led_1); // sbi 0x07, 1
    BiColorLedGreen(led_0); // cbi  0x08, 0
    BiColorLedGreen(led_1); // cbi  0x08, 1
}
void setup_SpiCommunication(void)
{
    // Configure as SPI slave, interrupts run `ISR(SPI_STC_vect)`
    SpiSlaveInit();
    // Queue incoming SPI bytes in a FIFO buffer.
    SpiFifo = QueueInit(spi_rx_buffer, max_length_of_queue);
}
void setup_DetectorReadout(void)
{
    // Talk to ADC with SPI interface using UART SPIM
    UartSpiInit();
#ifdef LIS
    // Power up the LIS-770i and drive with a 50kHz clock
    LisInit();
#endif
#ifdef S13131
    S13131PinSetup();
    S13131StartClocking();
#endif
    // Initialize exposure time to 1 millisecond
    exposure_ticks = 50; // 50 ticks = (1.0e-3 s)/(20.0e-6 s/tick)
    // ---Expected Assembly---
    // ldi  r24, 0x32   ; 50
    // ldi  r25, 0x00   ; 0
    // sts  0x011D, r25 ; 0x80011d <exposure_ticks+0x1>
    // 1c8: sts 0x011C, r24 ; 0x80011c <exposure_ticks>
 
#ifdef LIS
    // Initialize LIS-770i configuration globals
    binning = BINNING_ON;
    gain = GAIN_1X;
    active_rows = ALL_ROWS_ACTIVE;
    // ---Expected Assembly---
    // ldi  r24, 0x01   ; 1
    // sts  0x011E, r24 ; 0x80011e <binning>
    // sts  0x0140, r24 ; 0x800140 <gain>
    // ldi  r24, 0x1F   ; 31
    // sts  0x013B, r24 ; 0x80013b <active_rows>
 
    // Program LIS-770i with above configuration
    LisWriteConfig();
#endif
#ifdef S13131
    // No configuration
#endif
    /* ------------------------------- */
    /* | Initialize AutoExposeConfig | */
    /* ------------------------------- */
    // Initialize default auto-expose maximum number of tries
    max_tries = 12;
#ifdef LIS
    // Initialize default auto-expose pixel range to all 392 pixels.
    // Recommend user application trims pixel range to match wavelength map.
    start_pixel = 7; // first 6 pixels are optically meaningless
    stop_pixel = 392;
#endif
#ifdef S13131
    start_pixel = 1;
    stop_pixel = 512;
#endif
    // Initialize default auto-expose target peak range to 46420 ± 3277 counts
    target = 46420;
    target_tolerance = 3277;
    // Hard-code conservative estimate on dark offset
    // AutoExpose calculates gain ONLY when signal is above max_dark.
    // SetAutoExposeConfig guarantees target is not below max_dark.
    max_dark = 4500;
    // Hard-code minimum exposure time used by auto-expose.
#ifdef LIS
    // keep lower limit well-away from 1 cycle
    min_exposure = 5; // cycles
#endif
#ifdef S13131
    // 9 is the minimum set by the internal S13131-512 logic
    min_exposure = 9; // cycles
#endif
    // Initialize default auto-expose maximum exposure time to try.
    // upper limit is 1.3s, but 200ms is a practical default limit
    max_exposure = 10000; // cycles
}