[deliverable/linux.git] / include / uapi / misc / cxl.h

/*
 * Copyright 2014 IBM Corp.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version
 * 2 of the License, or (at your option) any later version.
 */

#ifndef _UAPI_MISC_CXL_H
#define _UAPI_MISC_CXL_H

#include <linux/types.h>
#include <linux/ioctl.h>


struct cxl_ioctl_start_work {
	__u64 flags;
	__u64 work_element_descriptor;
	__u64 amr;
	__s16 num_interrupts;
	__s16 reserved1;
	__s32 reserved2;
	__u64 reserved3;
	__u64 reserved4;
	__u64 reserved5;
	__u64 reserved6;
};

#define CXL_START_WORK_AMR		0x0000000000000001ULL
#define CXL_START_WORK_NUM_IRQS		0x0000000000000002ULL
#define CXL_START_WORK_ERR_FF		0x0000000000000004ULL
#define CXL_START_WORK_ALL		(CXL_START_WORK_AMR |\
					 CXL_START_WORK_NUM_IRQS |\
					 CXL_START_WORK_ERR_FF)


/* Possible modes that an afu can be in */
#define CXL_MODE_DEDICATED   0x1
#define CXL_MODE_DIRECTED    0x2

/* possible flags for the cxl_afu_id flags field */
#define CXL_AFUID_FLAG_SLAVE    0x1  /* In directed-mode afu is in slave mode */

struct cxl_afu_id {
	__u64 flags;     /* One of CXL_AFUID_FLAG_X */
	__u32 card_id;
	__u32 afu_offset;
	__u32 afu_mode;  /* one of the CXL_MODE_X */
	__u32 reserved1;
	__u64 reserved2;
	__u64 reserved3;
	__u64 reserved4;
	__u64 reserved5;
	__u64 reserved6;
};

/* base adapter image header is included in the image */
#define CXL_AI_NEED_HEADER	0x0000000000000001ULL
#define CXL_AI_ALL		CXL_AI_NEED_HEADER

#define CXL_AI_HEADER_SIZE 128
#define CXL_AI_BUFFER_SIZE 4096
#define CXL_AI_MAX_ENTRIES 256
#define CXL_AI_MAX_CHUNK_SIZE (CXL_AI_BUFFER_SIZE * CXL_AI_MAX_ENTRIES)

struct cxl_adapter_image {
	__u64 flags;
	__u64 data;
	__u64 len_data;
	__u64 len_image;
	__u64 reserved1;
	__u64 reserved2;
	__u64 reserved3;
	__u64 reserved4;
};

/* ioctl numbers */
#define CXL_MAGIC 0xCA
/* AFU devices */
#define CXL_IOCTL_START_WORK		_IOW(CXL_MAGIC, 0x00, struct cxl_ioctl_start_work)
#define CXL_IOCTL_GET_PROCESS_ELEMENT	_IOR(CXL_MAGIC, 0x01, __u32)
#define CXL_IOCTL_GET_AFU_ID            _IOR(CXL_MAGIC, 0x02, struct cxl_afu_id)
/* adapter devices */
#define CXL_IOCTL_DOWNLOAD_IMAGE        _IOW(CXL_MAGIC, 0x0A, struct cxl_adapter_image)
#define CXL_IOCTL_VALIDATE_IMAGE        _IOW(CXL_MAGIC, 0x0B, struct cxl_adapter_image)

#define CXL_READ_MIN_SIZE 0x1000 /* 4K */

/* Events from read() */
enum cxl_event_type {
	CXL_EVENT_RESERVED      = 0,
	CXL_EVENT_AFU_INTERRUPT = 1,
	CXL_EVENT_DATA_STORAGE  = 2,
	CXL_EVENT_AFU_ERROR     = 3,
	CXL_EVENT_AFU_DRIVER    = 4,
};

struct cxl_event_header {
	__u16 type;
	__u16 size;
	__u16 process_element;
	__u16 reserved1;
};

struct cxl_event_afu_interrupt {
	__u16 flags;
	__u16 irq; /* Raised AFU interrupt number */
	__u32 reserved1;
};

struct cxl_event_data_storage {
	__u16 flags;
	__u16 reserved1;
	__u32 reserved2;
	__u64 addr;
	__u64 dsisr;
	__u64 reserved3;
};

struct cxl_event_afu_error {
	__u16 flags;
	__u16 reserved1;
	__u32 reserved2;
	__u64 error;
};

struct cxl_event_afu_driver_reserved {
	/*
	 * Defines the buffer passed to the cxl driver by the AFU driver.
	 *
	 * This is not ABI since the event header.size passed to the user for
	 * existing events is set in the read call to sizeof(cxl_event_header)
	 * + sizeof(whatever event is being dispatched) and the user is already
	 * required to use a 4K buffer on the read call.
	 *
	 * Of course the contents will be ABI, but that's up the AFU driver.
	 */
	__u32 data_size;
	__u8 data[];
};

struct cxl_event {
	struct cxl_event_header header;
	union {
		struct cxl_event_afu_interrupt irq;
		struct cxl_event_data_storage fault;
		struct cxl_event_afu_error afu_error;
		struct cxl_event_afu_driver_reserved afu_driver_event;
	};
};

#endif /* _UAPI_MISC_CXL_H */
Commit	Line	Data
66b43081 IM	1	/*
	2	* Copyright 2014 IBM Corp.
	3	*
	4	* This program is free software; you can redistribute it and/or
	5	* modify it under the terms of the GNU General Public License
	6	* as published by the Free Software Foundation; either version
	7	* 2 of the License, or (at your option) any later version.
	8	*/
	9
	10	#ifndef _UAPI_MISC_CXL_H
	11	#define _UAPI_MISC_CXL_H
	12
	13	#include <linux/types.h>
	14	#include <linux/ioctl.h>
	15
a9282d01	16
66b43081 IM	17	struct cxl_ioctl_start_work {
	18	__u64 flags;
	19	__u64 work_element_descriptor;
	20	__u64 amr;
	21	__s16 num_interrupts;
	22	__s16 reserved1;
	23	__s32 reserved2;
	24	__u64 reserved3;
	25	__u64 reserved4;
	26	__u64 reserved5;
	27	__u64 reserved6;
	28	};
a9282d01	29
66b43081 IM	30	#define CXL_START_WORK_AMR 0x0000000000000001ULL
66b43081 IM	31	#define CXL_START_WORK_NUM_IRQS 0x0000000000000002ULL
d9232a3d	32	#define CXL_START_WORK_ERR_FF 0x0000000000000004ULL
66b43081	33	#define CXL_START_WORK_ALL (CXL_START_WORK_AMR \|\
d9232a3d IM	34	CXL_START_WORK_NUM_IRQS \|\
d9232a3d IM	35	CXL_START_WORK_ERR_FF)
66b43081	36
27d4dc71 VJ	37
	38	/* Possible modes that an afu can be in */
	39	#define CXL_MODE_DEDICATED 0x1
	40	#define CXL_MODE_DIRECTED 0x2
	41
	42	/* possible flags for the cxl_afu_id flags field */
	43	#define CXL_AFUID_FLAG_SLAVE 0x1 /* In directed-mode afu is in slave mode */
	44
	45	struct cxl_afu_id {
	46	__u64 flags; /* One of CXL_AFUID_FLAG_X */
	47	__u32 card_id;
	48	__u32 afu_offset;
	49	__u32 afu_mode; /* one of the CXL_MODE_X */
	50	__u32 reserved1;
	51	__u64 reserved2;
	52	__u64 reserved3;
	53	__u64 reserved4;
	54	__u64 reserved5;
	55	__u64 reserved6;
	56	};
	57
594ff7d0 CL	58	/* base adapter image header is included in the image */
	59	#define CXL_AI_NEED_HEADER 0x0000000000000001ULL
	60	#define CXL_AI_ALL CXL_AI_NEED_HEADER
	61
	62	#define CXL_AI_HEADER_SIZE 128
	63	#define CXL_AI_BUFFER_SIZE 4096
	64	#define CXL_AI_MAX_ENTRIES 256
	65	#define CXL_AI_MAX_CHUNK_SIZE (CXL_AI_BUFFER_SIZE * CXL_AI_MAX_ENTRIES)
	66
	67	struct cxl_adapter_image {
	68	__u64 flags;
	69	__u64 data;
	70	__u64 len_data;
	71	__u64 len_image;
	72	__u64 reserved1;
	73	__u64 reserved2;
	74	__u64 reserved3;
	75	__u64 reserved4;
	76	};
	77
a9282d01	78	/* ioctl numbers */
66b43081	79	#define CXL_MAGIC 0xCA
594ff7d0	80	/* AFU devices */
66b43081 IM	81	#define CXL_IOCTL_START_WORK _IOW(CXL_MAGIC, 0x00, struct cxl_ioctl_start_work)
66b43081 IM	82	#define CXL_IOCTL_GET_PROCESS_ELEMENT _IOR(CXL_MAGIC, 0x01, __u32)
27d4dc71	83	#define CXL_IOCTL_GET_AFU_ID _IOR(CXL_MAGIC, 0x02, struct cxl_afu_id)
594ff7d0 CL	84	/* adapter devices */
	85	#define CXL_IOCTL_DOWNLOAD_IMAGE _IOW(CXL_MAGIC, 0x0A, struct cxl_adapter_image)
	86	#define CXL_IOCTL_VALIDATE_IMAGE _IOW(CXL_MAGIC, 0x0B, struct cxl_adapter_image)
66b43081	87
66b43081 IM	88	#define CXL_READ_MIN_SIZE 0x1000 /* 4K */
66b43081 IM	89
a9282d01	90	/* Events from read() */
66b43081 IM	91	enum cxl_event_type {
	92	CXL_EVENT_RESERVED = 0,
	93	CXL_EVENT_AFU_INTERRUPT = 1,
	94	CXL_EVENT_DATA_STORAGE = 2,
	95	CXL_EVENT_AFU_ERROR = 3,
b810253b	96	CXL_EVENT_AFU_DRIVER = 4,
66b43081 IM	97	};
	98
	99	struct cxl_event_header {
	100	__u16 type;
	101	__u16 size;
	102	__u16 process_element;
	103	__u16 reserved1;
	104	};
	105
	106	struct cxl_event_afu_interrupt {
	107	__u16 flags;
	108	__u16 irq; /* Raised AFU interrupt number */
	109	__u32 reserved1;
	110	};
	111
	112	struct cxl_event_data_storage {
	113	__u16 flags;
	114	__u16 reserved1;
	115	__u32 reserved2;
	116	__u64 addr;
	117	__u64 dsisr;
	118	__u64 reserved3;
	119	};
	120
	121	struct cxl_event_afu_error {
	122	__u16 flags;
	123	__u16 reserved1;
	124	__u32 reserved2;
	125	__u64 error;
	126	};
	127
b810253b PB	128	struct cxl_event_afu_driver_reserved {
	129	/*
	130	* Defines the buffer passed to the cxl driver by the AFU driver.
	131	*
	132	* This is not ABI since the event header.size passed to the user for
	133	* existing events is set in the read call to sizeof(cxl_event_header)
	134	* + sizeof(whatever event is being dispatched) and the user is already
	135	* required to use a 4K buffer on the read call.
	136	*
	137	* Of course the contents will be ABI, but that's up the AFU driver.
	138	*/
cbd74e1b PB	139	__u32 data_size;
cbd74e1b PB	140	__u8 data[];
b810253b PB	141	};
b810253b PB	142
66b43081 IM	143	struct cxl_event {
	144	struct cxl_event_header header;
	145	union {
	146	struct cxl_event_afu_interrupt irq;
	147	struct cxl_event_data_storage fault;
	148	struct cxl_event_afu_error afu_error;
b810253b	149	struct cxl_event_afu_driver_reserved afu_driver_event;
66b43081 IM	150	};
	151	};
	152
	153	#endif /* _UAPI_MISC_CXL_H */