ec150c7e09
Back in 2016, we discussed[1] rules for headers, and these were
generally liked:
1. Have a carefully curated header that's included everywhere first. We
got that already thanks to Peter: osdep.h.
2. Headers should normally include everything they need beyond osdep.h.
If exceptions are needed for some reason, they must be documented in
the header. If all that's needed from a header is typedefs, put
those into qemu/typedefs.h instead of including the header.
3. Cyclic inclusion is forbidden.
This patch gets include/ closer to obeying 2.
It's actually extracted from my "[RFC] Baby steps towards saner
headers" series[2], which demonstrates a possible path towards
checking 2 automatically. It passes the RFC test there.
[1] Message-ID: <87h9g8j57d.fsf@blackfin.pond.sub.org>
https://lists.nongnu.org/archive/html/qemu-devel/2016-03/msg03345.html
[2] Message-Id: <20190711122827.18970-1-armbru@redhat.com>
https://lists.nongnu.org/archive/html/qemu-devel/2019-07/msg02715.html
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Alistair Francis <alistair.francis@wdc.com>
Message-Id: <20190812052359.30071-2-armbru@redhat.com>
Tested-by: Philippe Mathieu-Daudé <philmd@redhat.com>
54 lines
1.3 KiB
C
54 lines
1.3 KiB
C
/*
|
|
* Semihosting Console
|
|
*
|
|
* Copyright (c) 2019 Linaro Ltd
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later
|
|
*/
|
|
|
|
#ifndef SEMIHOST_CONSOLE_H
|
|
#define SEMIHOST_CONSOLE_H
|
|
|
|
#include "cpu.h"
|
|
|
|
/**
|
|
* qemu_semihosting_console_outs:
|
|
* @env: CPUArchState
|
|
* @s: host address of null terminated guest string
|
|
*
|
|
* Send a null terminated guest string to the debug console. This may
|
|
* be the remote gdb session if a softmmu guest is currently being
|
|
* debugged.
|
|
*
|
|
* Returns: number of bytes written.
|
|
*/
|
|
int qemu_semihosting_console_outs(CPUArchState *env, target_ulong s);
|
|
|
|
/**
|
|
* qemu_semihosting_console_outc:
|
|
* @env: CPUArchState
|
|
* @s: host address of null terminated guest string
|
|
*
|
|
* Send single character from guest memory to the debug console. This
|
|
* may be the remote gdb session if a softmmu guest is currently being
|
|
* debugged.
|
|
*
|
|
* Returns: nothing
|
|
*/
|
|
void qemu_semihosting_console_outc(CPUArchState *env, target_ulong c);
|
|
|
|
/**
|
|
* qemu_semihosting_log_out:
|
|
* @s: pointer to string
|
|
* @len: length of string
|
|
*
|
|
* Send a string to the debug output. Unlike console_out these strings
|
|
* can't be sent to a remote gdb instance as they don't exist in guest
|
|
* memory.
|
|
*
|
|
* Returns: number of bytes written
|
|
*/
|
|
int qemu_semihosting_log_out(const char *s, int len);
|
|
|
|
#endif /* SEMIHOST_CONSOLE_H */
|