[mirror_spl.git] / include / splat-ctl.h

#ifndef _SPLAT_CTL_H
#define _SPLAT_CTL_H

/* Contains shared definitions which both the userspace
 * and kernelspace portions of splat must agree on.
 */

#define SPLAT_MAJOR			229 /* XXX - Arbitrary */
#define SPLAT_MINORS                    1
#define SPLAT_DEV			"/dev/splatctl"

#define SPLAT_NAME_SIZE			12
#define SPLAT_DESC_SIZE			60

typedef struct splat_user {
	char name[SPLAT_NAME_SIZE];	/* short name */
	char desc[SPLAT_DESC_SIZE];	/* short description */
	int id;				/* unique numeric id */
} splat_user_t;

#define	SPLAT_CFG_MAGIC			0x15263748U
typedef struct splat_cfg {
	unsigned int cfg_magic;		/* Unique magic */
	int cfg_cmd;			/* Config command */
	int cfg_arg1;			/* Config command arg 1 */
	int cfg_rc1;			/* Config response 1 */
	union {
		struct {
			int size;
			splat_user_t descs[0];
		} splat_subsystems;
		struct {
			int size;
			splat_user_t descs[0];
		} splat_tests;
	} cfg_data;
} splat_cfg_t;

#define	SPLAT_CMD_MAGIC			0x9daebfc0U
typedef struct splat_cmd {
	unsigned int cmd_magic;		/* Unique magic */
	int cmd_subsystem;		/* Target subsystem */
	int cmd_test;			/* Subsystem test */
	int cmd_data_size;		/* Extra opaque data */
	char cmd_data_str[0];		/* Opaque data region */
} splat_cmd_t;

/* Valid ioctls */
#define SPLAT_CFG				_IOWR('f', 101, long)
#define SPLAT_CMD				_IOWR('f', 102, long)

/* Valid configuration commands */
#define SPLAT_CFG_BUFFER_CLEAR		0x001	/* Clear text buffer */
#define SPLAT_CFG_BUFFER_SIZE		0x002	/* Resize text buffer */
#define SPLAT_CFG_SUBSYSTEM_COUNT	0x101	/* Number of subsystem */
#define SPLAT_CFG_SUBSYSTEM_LIST	0x102	/* List of N subsystems */
#define SPLAT_CFG_TEST_COUNT		0x201	/* Number of tests */
#define SPLAT_CFG_TEST_LIST		0x202	/* List of N tests */

/* Valid subsystem and test commands defined in each subsystem, we do
 * need to be careful to avoid colisions.  That alone may argue to define
 * them all here, for now we just define the global error codes.
 */
#define SPLAT_SUBSYSTEM_UNKNOWN		0xF00
#define SPLAT_TEST_UNKNOWN		0xFFF

#endif /* _SPLAT_CTL_H */
Commit	Line	Data
ea70970f	1	#ifndef _SPLAT_CTL_H
	2	#define _SPLAT_CTL_H
	3
	4	/* Contains shared definitions which both the userspace
	5	* and kernelspace portions of splat must agree on.
	6	*/
	7
	8	#define SPLAT_MAJOR 229 /* XXX - Arbitrary */
	9	#define SPLAT_MINORS 1
	10	#define SPLAT_DEV "/dev/splatctl"
	11
	12	#define SPLAT_NAME_SIZE 12
	13	#define SPLAT_DESC_SIZE 60
	14
	15	typedef struct splat_user {
	16	char name[SPLAT_NAME_SIZE]; /* short name */
	17	char desc[SPLAT_DESC_SIZE]; /* short description */
	18	int id; /* unique numeric id */
	19	} splat_user_t;
	20
	21	#define SPLAT_CFG_MAGIC 0x15263748U
	22	typedef struct splat_cfg {
	23	unsigned int cfg_magic; /* Unique magic */
	24	int cfg_cmd; /* Config command */
	25	int cfg_arg1; /* Config command arg 1 */
	26	int cfg_rc1; /* Config response 1 */
	27	union {
	28	struct {
	29	int size;
	30	splat_user_t descs[0];
	31	} splat_subsystems;
	32	struct {
	33	int size;
	34	splat_user_t descs[0];
	35	} splat_tests;
	36	} cfg_data;
	37	} splat_cfg_t;
	38
	39	#define SPLAT_CMD_MAGIC 0x9daebfc0U
	40	typedef struct splat_cmd {
	41	unsigned int cmd_magic; /* Unique magic */
	42	int cmd_subsystem; /* Target subsystem */
	43	int cmd_test; /* Subsystem test */
	44	int cmd_data_size; /* Extra opaque data */
	45	char cmd_data_str[0]; /* Opaque data region */
	46	} splat_cmd_t;
	47
	48	/* Valid ioctls */
	49	#define SPLAT_CFG _IOWR('f', 101, long)
	50	#define SPLAT_CMD _IOWR('f', 102, long)
	51
	52	/* Valid configuration commands */
	53	#define SPLAT_CFG_BUFFER_CLEAR 0x001 /* Clear text buffer */
	54	#define SPLAT_CFG_BUFFER_SIZE 0x002 /* Resize text buffer */
b831734a	55	#define SPLAT_CFG_SUBSYSTEM_COUNT 0x101 /* Number of subsystem */
b831734a	56	#define SPLAT_CFG_SUBSYSTEM_LIST 0x102 /* List of N subsystems */
ea70970f	57	#define SPLAT_CFG_TEST_COUNT 0x201 /* Number of tests */
	58	#define SPLAT_CFG_TEST_LIST 0x202 /* List of N tests */
	59
	60	/* Valid subsystem and test commands defined in each subsystem, we do
	61	* need to be careful to avoid colisions. That alone may argue to define
	62	* them all here, for now we just define the global error codes.
	63	*/
	64	#define SPLAT_SUBSYSTEM_UNKNOWN 0xF00
	65	#define SPLAT_TEST_UNKNOWN 0xFFF
	66
	67	#endif /* _SPLAT_CTL_H */