libsel4platsupport/include/sel4platsupport/platsupport.h

/*
 * Copyright 2017, Data61
 * Commonwealth Scientific and Industrial Research Organisation (CSIRO)
 * ABN 41 687 119 230.
 *
 * This software may be distributed and modified according to the terms of
 * the BSD 2-Clause license. Note that NO WARRANTY is provided.
 * See "LICENSE_BSD2.txt" for details.
 *
 * @TAG(DATA61_BSD)
 */

#pragma once

#include <vspace/vspace.h>
#include <simple/simple.h>
#include <vka/vka.h>
#include <platsupport/io.h>
#include <platsupport/chardev.h>
#include <sel4platsupport/bootinfo.h>

/* performs a legacy failsafe initialisation of the serial port. This will stomp
 * over your virtual address space in unpredictable ways and is generally not
 * recommended */
int
platsupport_serial_setup_bootinfo_failsafe(void);

/* Initialises the serial device. Requires a simple_t * so that caps can be located as well as a vka_t to allocate at slot, and a vspace in case a memory mapped device is required */
int
platsupport_serial_setup_simple(vspace_t *vspace, simple_t *simple, vka_t *vka);

/* Initialses the serial device. Requires an io_ops_t* for device IO and mappings */
int
platsupport_serial_setup_io_ops(ps_io_ops_t* io_ops);

/* Register a character device for __plat_put/get_char redirection */
void
register_console(ps_chardevice_t* user_console);

void
platsupport_undo_serial_setup(void);

void
platsupport_serial_input_init_IRQ(void);