doom_riscv/projects/riscv_usb/fw/fw_app.c

/*
 * fw_app.c
 *
 * Copyright (C) 2019 Sylvain Munaut
 * All rights reserved.
 *
 * LGPL v3+, see LICENSE.lgpl3
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */

#include <stdint.h>
#include <stdbool.h>
#include <string.h>

#include "console.h"
#include "led.h"
#include "mini-printf.h"
#include "spi.h"
#include "utils.h"
#include "registers.h"
#include "generation.h"

/* FLASH */
#define FLASH_MAILBOX_STORAGE 0x0F0000

static uint32_t copy_array[16];

/*
double dupa;
float kupa;
*/

/* Local generation params for tweaking actual HW generation params */
static tweaked_params_union_s out_params;


static inline uint32_t rdcycle(void)
{
    uint32_t cycle;
    __asm__ volatile ("rdcycle %0" : "=r" (cycle));
    return cycle;
}

/* Timer fuction */
#define CYCLES_DIV 24000000.0f
#define UPDATE_MS 0.1f
// TODO: integers not floats?

static uint32_t last_rdcycle;
static bool timer_expired()
{
    bool success = false;
    uint32_t current = rdcycle();
    uint32_t diff = current - last_rdcycle;
    //printf(" diff %d last: %d current: %d\n", diff, last_rdcycle, current);
    // TODO: overflow handling
    float elapsed_seconds = (float)(diff) / CYCLES_DIV;
    if (elapsed_seconds > UPDATE_MS)
    {
        last_rdcycle = current;
        //printf("Timer expired!\n");
        success = true;;
    }
    return success;
}

static void write_regs_to_mailbox()
{
    mailbox_regs->regs.period1 = out_params.regs._period1;
    // TODO: seems like period2 etc are missing
    mailbox_regs->regs.delay1 = out_params.regs.D1 / FXP_SCALING;
    //mailbox_regs->regs.period2 = out_params.regs._period2;
    mailbox_regs->regs.delay2 = out_params.regs.D2 / FXP_SCALING;
    //mailbox_regs->regs.duty3 = out_params.regs._du
    mailbox_regs->regs.delay3 = out_params.regs.D3 / FXP_SCALING;
    mailbox_regs->regs.npuls3 = out_params.regs.N3;
    mailbox_regs->regs.odd_train_flag = N_PULSE_TRAINS; // TODO: is this proper?
    mailbox_regs->regs.ena_odd_out3 = out_params.regs.ena;
}

static void clear_button_regs()
{
    for (int i = 0; i < 16; ++i)
        mailbox_button_regs->data[i] = 0x0;
}

static void print_mailbox_contents()
{
    int i = 0;
    printf("Mailbox contents:\n");
    for(i = 0; i < 16; ++i)
        printf("Mailbox[%d]: %d\n", i, mailbox_regs->data[i]);
}

static void read_generation_values_from_flash()
{
    flash_read((void*)copy_array, FLASH_MAILBOX_STORAGE, sizeof(copy_array));

    // Copy data to actual registers
    for (int i = 0; i < 14; ++i)
        out_params.data[i] = copy_array[i];
}

static void store_generation_values_flash()
{
	// TODO: can we remove it already as we don't read directly to mailbox
    // Copy current mailbox array to a temporary array for bulk memory write
    // our Wishbone implementation does not support bulk writes
    for (int i = 0; i < 16; ++i)
        copy_array[i] = out_params.data[i];

    flash_write_enable();
    flash_sector_erase(FLASH_MAILBOX_STORAGE);
    // Wait for flash to finish (poll status register)
    while (flash_read_sr() & 0x01) /* WIP bit */;
    flash_write_enable();

    flash_page_program((void*)copy_array, FLASH_MAILBOX_STORAGE, sizeof(copy_array));
    while (flash_read_sr() & 0x01) /* WIP bit */;
}

static void
serial_no_init()
{
	uint8_t buf[8];

	flash_manuf_id(buf);
	printf("Flash Manufacturer : %s\n", hexstr(buf, 3, true));

	flash_unique_id(buf);
	printf("Flash Unique ID    : %s\n", hexstr(buf, 8, true));

    //dummy_write_to_flash();

    /* Testing floats TODO: test if calculation is correct
    dupa = 3.1415;
    kupa = 2.74f;

    dupa *= kupa;

    printf("Pi * e: %.3f\n", dupa);
    */
}

//static char _printf_buf[128];

static void write_period1()
{
    printf("Writing period1 0x1\n");
    mailbox_regs->regs.period1 = 0x1;
    printf("Done writing\n");

    print_mailbox_contents();
    //store_mailbox_regs_flash();
}

static void write_period1_2()
{
    printf("Writing period1 0x2\n");
    mailbox_regs->regs.period1 = 0x2;
    printf("Done writing\n");

    print_mailbox_contents();
    //store_mailbox_regs_flash();
}

static void write_period1_4()
{
    printf("Writing period1 0x4\n");
    mailbox_regs->regs.period1 = 0x4;
    printf("Done writing\n");
    printf("Reading now \n");
    printf("value: %d\n", mailbox_regs->regs.period1);
    print_mailbox_contents();
    //store_mailbox_regs_flash();
}

static void clear_period1()
{
    printf("Clearing period1 val: %d\n", mailbox_regs->regs.period1);
    mailbox_regs->regs.period1 = 0x0;
    printf("Done clearing\n");
}

static void write_delay1()
{
    printf("Writing delay1 0x1234\n");
    mailbox_regs->regs.delay1 = 0x1234;
    printf("Done writing\n");
    //store_mailbox_regs_flash();
}

static void clear_delay1()
{
    printf("Clearing delay1 val: %d\n", mailbox_regs->regs.delay1);
    mailbox_regs->regs.delay1 = 0x0;
    printf("Done clearing\n");
}

static void print_flash_contents()
{
    read_generation_values_from_flash();
    print_mailbox_contents();
}

static void
boot_dfu(void)
{
	/* Boot firmware */
	volatile uint32_t *boot = (void*)0x80000000;
	*boot = (1 << 2) | (1 << 0);
}

void
usb_dfu_rt_cb_reboot(void)
{
    boot_dfu();
}

void main()
{
	int cmd = 0;

	/* Init console IO */
	console_init();
	puts("Booting App image..\n");

	/* LED */
	led_init();
	led_color(48, 96, 5);
	led_blink(true, 200, 1000);
	led_breathe(true, 100, 200);
	led_state(true);

	/* SPI */
	spi_init();

	/* Enable USB directly */
	serial_no_init();

    /* Read generation reg values from flash */
    read_generation_values_from_flash();

	/* If values are wrong - fill defaults */
	if (validate_generation_values(&out_params.regs) != 0)
        init_params(&out_params.regs);

    write_regs_to_mailbox();

	/* Main loop */
	while (1)
	{
        /* Run the timer for button updates periodically */
        if (timer_expired())
        {
            update_three_signal_values(&out_params.regs, mailbox_button_regs);
            // button registers have to be cleared upon reading
            clear_button_regs();
            write_regs_to_mailbox();
            if (mailbox_regs->regs.write_flash)
            {
                store_generation_values_flash();
                mailbox_regs->regs.write_flash = 0x0;
            }
        }

        // TODO: Add incrementing/decrementing values from console
#ifdef USE_KEYBOARD
		/* Prompt ? */
		if (cmd >= 0)
			printf("Command> ");

		/* Poll for command */
		cmd = getchar_nowait();

		if (cmd >= 0) {
			if (cmd > 32 && cmd < 127) {
				putchar(cmd);
				putchar('\r');
				putchar('\n');
			}

			switch (cmd)
			{
            case 'q':
                printf("Current rdcycle %d\n", rdcycle());
                break;
			case 'b':
				boot_dfu();
				break;
            case 'w':
                write_period1();
                break;
            case 'k':
                clear_period1();
                break;
            case 'a':
                write_period1_2();
                break;
            case 's':
                write_period1_4();
                break;
            case 'o':
                write_delay1();
                break;
            case 'm':
                clear_delay1();
                break;
            case 'f':
                print_flash_contents();
                break;
			default:
				break;
			}
		}
#endif
        }
}