semihost.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022, Commonwealth Scientific and Industrial Research
 * Organisation (CSIRO) ABN 41 687 119 230.
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Based on the ARM semihosting API from:
 * https://github.com/ARM-software/abi-aa/blob/main/semihosting/semihosting.rst
 *
 * RISC-V semihosting also follows these conventions:
 * https://github.com/riscv/riscv-semihosting-spec/blob/main/riscv-semihosting-spec.adoc
 */
 
#ifndef ZEPHYR_INCLUDE_ARCH_COMMON_SEMIHOST_H_
#define ZEPHYR_INCLUDE_ARCH_COMMON_SEMIHOST_H_
 
enum semihost_instr {
        /*
         * File I/O operations
         */
 
        SEMIHOST_OPEN   = 0x01,
        SEMIHOST_ISTTY  = 0x09,
        SEMIHOST_WRITE  = 0x05,
        SEMIHOST_READ   = 0x06,
        SEMIHOST_CLOSE  = 0x02,
        SEMIHOST_FLEN   = 0x0C,
        SEMIHOST_SEEK   = 0x0A,
        SEMIHOST_TMPNAM = 0x0D,
        SEMIHOST_REMOVE = 0x0E,
        SEMIHOST_RENAME = 0x0F,
 
        /*
         * Terminal I/O operations
         */
 
        SEMIHOST_WRITEC         = 0x03,
        SEMIHOST_WRITE0         = 0x04,
        SEMIHOST_READC          = 0x07,
 
        /*
         * Time operations
         */
        SEMIHOST_CLOCK          = 0x10,
        SEMIHOST_ELAPSED        = 0x30,
        SEMIHOST_TICKFREQ       = 0x31,
        SEMIHOST_TIME           = 0x11,
 
        /*
         * System/Misc. operations
         */
 
        SEMIHOST_ERRNO          = 0x13,
        SEMIHOST_GET_CMDLINE    = 0x15,
        SEMIHOST_HEAPINFO       = 0x16,
        SEMIHOST_ISERROR        = 0x08,
        SEMIHOST_SYSTEM         = 0x12
};
 
enum semihost_open_mode {
        SEMIHOST_OPEN_R         = 0,
        SEMIHOST_OPEN_RB        = 1,
        SEMIHOST_OPEN_R_PLUS    = 2,
        SEMIHOST_OPEN_RB_PLUS   = 3,
        SEMIHOST_OPEN_W         = 4,
        SEMIHOST_OPEN_WB        = 5,
        SEMIHOST_OPEN_W_PLUS    = 6,
        SEMIHOST_OPEN_WB_PLUS   = 7,
        SEMIHOST_OPEN_A         = 8,
        SEMIHOST_OPEN_AB        = 9,
        SEMIHOST_OPEN_A_PLUS    = 10,
        SEMIHOST_OPEN_AB_PLUS   = 11,
};
 
long semihost_exec(enum semihost_instr instr, void *args);
 
char semihost_poll_in(void);
 
void semihost_poll_out(char c);
 
long semihost_open(const char *path, long mode);
 
long semihost_close(long fd);
 
long semihost_flen(long fd);
 
long semihost_seek(long fd, long offset);
 
long semihost_read(long fd, void *buf, long len);
 
long semihost_write(long fd, const void *buf, long len);
 
#endif /* ZEPHYR_INCLUDE_ARCH_COMMON_SEMIHOST_H_ */