LXR qemu/include/hw/semihosting/console.h

   1/*
   2 * Semihosting Console
   3 *
   4 * Copyright (c) 2019 Linaro Ltd
   5 *
   6 * SPDX-License-Identifier: GPL-2.0-or-later
   7 */
   8
   9#ifndef SEMIHOST_CONSOLE_H
  10#define SEMIHOST_CONSOLE_H
  11
  12#include "cpu.h"
  13
  14/**
  15 * qemu_semihosting_console_outs:
  16 * @env: CPUArchState
  17 * @s: host address of null terminated guest string
  18 *
  19 * Send a null terminated guest string to the debug console. This may
  20 * be the remote gdb session if a softmmu guest is currently being
  21 * debugged.
  22 *
  23 * Returns: number of bytes written.
  24 */
  25int qemu_semihosting_console_outs(CPUArchState *env, target_ulong s);
  26
  27/**
  28 * qemu_semihosting_console_outc:
  29 * @env: CPUArchState
  30 * @s: host address of null terminated guest string
  31 *
  32 * Send single character from guest memory to the debug console. This
  33 * may be the remote gdb session if a softmmu guest is currently being
  34 * debugged.
  35 *
  36 * Returns: nothing
  37 */
  38void qemu_semihosting_console_outc(CPUArchState *env, target_ulong c);
  39
  40/**
  41 * qemu_semihosting_console_inc:
  42 * @env: CPUArchState
  43 *
  44 * Receive single character from debug console. This may be the remote
  45 * gdb session if a softmmu guest is currently being debugged. As this
  46 * call may block if no data is available we suspend the CPU and will
  47 * re-execute the instruction when data is there. Therefore two
  48 * conditions must be met:
  49 *   - CPUState is synchronized before calling this function
  50 *   - pc is only updated once the character is successfully returned
  51 *
  52 * Returns: character read OR cpu_loop_exit!
  53 */
  54target_ulong qemu_semihosting_console_inc(CPUArchState *env);
  55
  56/**
  57 * qemu_semihosting_log_out:
  58 * @s: pointer to string
  59 * @len: length of string
  60 *
  61 * Send a string to the debug output. Unlike console_out these strings
  62 * can't be sent to a remote gdb instance as they don't exist in guest
  63 * memory.
  64 *
  65 * Returns: number of bytes written
  66 */
  67int qemu_semihosting_log_out(const char *s, int len);
  68
  69#endif /* SEMIHOST_CONSOLE_H */
  70