mirror of
https://gitlab.uni-freiburg.de/opensourcevdi/spice
synced 2025-12-26 06:32:44 +00:00
9462537d24
Found with readability-inconsistent-declaration-parameter-name Signed-off-by: Rosen Penev <rosenp@gmail.com> Acked-by: Frediano Ziglio <freddy77@gmail.com>
93 lines
3.3 KiB
C
93 lines
3.3 KiB
C
/*
|
|
* Copyright (C) 2009-2014 Red Hat, Inc.
|
|
*
|
|
* This library 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 2.1 of the License, or (at your option) any later version.
|
|
*
|
|
* This library 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 library; if not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef SPICE_CHAR_H_
|
|
#define SPICE_CHAR_H_
|
|
|
|
#if !defined(SPICE_H_INSIDE) && !defined(SPICE_SERVER_INTERNAL)
|
|
#error "Only spice.h can be included directly."
|
|
#endif
|
|
|
|
#include "spice-core.h"
|
|
|
|
SPICE_BEGIN_DECLS
|
|
|
|
/* char device interfaces */
|
|
|
|
#define SPICE_INTERFACE_CHAR_DEVICE "char_device"
|
|
#define SPICE_INTERFACE_CHAR_DEVICE_MAJOR 1
|
|
#define SPICE_INTERFACE_CHAR_DEVICE_MINOR 3
|
|
typedef struct SpiceCharDeviceInterface SpiceCharDeviceInterface;
|
|
typedef struct SpiceCharDeviceInstance SpiceCharDeviceInstance;
|
|
typedef struct SpiceCharDeviceState SpiceCharDeviceState;
|
|
|
|
typedef enum {
|
|
SPICE_CHAR_DEVICE_NOTIFY_WRITABLE = 1 << 0,
|
|
} spice_char_device_flags;
|
|
|
|
struct SpiceCharDeviceInterface {
|
|
SpiceBaseInterface base;
|
|
|
|
/* Set the state of the device.
|
|
* connected should be 0 or 1.
|
|
* Setting state to 0 causes the device to be disabled.
|
|
* This can be used by SPICE server to tell guest that device is not
|
|
* working anymore (for instance because the guest itself sent some
|
|
* wrong request).
|
|
*/
|
|
void (*state)(SpiceCharDeviceInstance *sin, int connected);
|
|
|
|
/* Write some bytes to the character device.
|
|
* Returns bytes copied from buf or a value < 0 on errors.
|
|
* If able to write some bytes the function should return the amount of
|
|
* bytes successfully written.
|
|
* Function can return a value < len, even 0.
|
|
* errno is not determined after calling this function.
|
|
* Function should be implemented as no-blocking.
|
|
* A len < 0 causes indeterminate results.
|
|
*/
|
|
int (*write)(SpiceCharDeviceInstance *sin, const uint8_t *buf, int len);
|
|
|
|
/* Read some bytes from the character device.
|
|
* Returns bytes copied into buf or a value < 0 on errors.
|
|
* Function can return 0 if no data is available or len is 0.
|
|
* errno is not determined after calling this function.
|
|
* Function should be implemented as no-blocking.
|
|
* A len < 0 causes indeterminate results.
|
|
*/
|
|
int (*read)(SpiceCharDeviceInstance *sin, uint8_t *buf, int len);
|
|
|
|
void (*event)(SpiceCharDeviceInstance *sin, uint8_t event);
|
|
spice_char_device_flags flags;
|
|
};
|
|
|
|
struct SpiceCharDeviceInstance {
|
|
SpiceBaseInstance base;
|
|
const char* subtype;
|
|
SpiceCharDeviceState *st;
|
|
const char* portname;
|
|
};
|
|
|
|
void spice_server_char_device_wakeup(SpiceCharDeviceInstance *sin);
|
|
void spice_server_port_event(SpiceCharDeviceInstance *sin, uint8_t event);
|
|
/* TODO change return to const char *const * when API break */
|
|
const char** spice_server_char_device_recognized_subtypes(void);
|
|
|
|
SPICE_END_DECLS
|
|
|
|
#endif /* SPICE_CHAR_H_ */
|