xref: /OK3568_Linux_fs/kernel/arch/sparc/include/uapi/asm/oradax.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-or-later WITH Linux-syscall-note */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
4*4882a593Smuzhiyun  */
5*4882a593Smuzhiyun 
6*4882a593Smuzhiyun /*
7*4882a593Smuzhiyun  * Oracle DAX driver API definitions
8*4882a593Smuzhiyun  */
9*4882a593Smuzhiyun 
10*4882a593Smuzhiyun #ifndef _ORADAX_H
11*4882a593Smuzhiyun #define	_ORADAX_H
12*4882a593Smuzhiyun 
13*4882a593Smuzhiyun #include <linux/types.h>
14*4882a593Smuzhiyun 
15*4882a593Smuzhiyun #define	CCB_KILL 0
16*4882a593Smuzhiyun #define	CCB_INFO 1
17*4882a593Smuzhiyun #define	CCB_DEQUEUE 2
18*4882a593Smuzhiyun 
19*4882a593Smuzhiyun struct dax_command {
20*4882a593Smuzhiyun 	__u16 command;		/* CCB_KILL/INFO/DEQUEUE */
21*4882a593Smuzhiyun 	__u16 ca_offset;	/* offset into mmapped completion area */
22*4882a593Smuzhiyun };
23*4882a593Smuzhiyun 
24*4882a593Smuzhiyun struct ccb_kill_result {
25*4882a593Smuzhiyun 	__u16 action;		/* action taken to kill ccb */
26*4882a593Smuzhiyun };
27*4882a593Smuzhiyun 
28*4882a593Smuzhiyun struct ccb_info_result {
29*4882a593Smuzhiyun 	__u16 state;		/* state of enqueued ccb */
30*4882a593Smuzhiyun 	__u16 inst_num;		/* dax instance number of enqueued ccb */
31*4882a593Smuzhiyun 	__u16 q_num;		/* queue number of enqueued ccb */
32*4882a593Smuzhiyun 	__u16 q_pos;		/* ccb position in queue */
33*4882a593Smuzhiyun };
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun struct ccb_exec_result {
36*4882a593Smuzhiyun 	__u64	status_data;	/* additional status data (e.g. bad VA) */
37*4882a593Smuzhiyun 	__u32	status;		/* one of DAX_SUBMIT_* */
38*4882a593Smuzhiyun };
39*4882a593Smuzhiyun 
40*4882a593Smuzhiyun union ccb_result {
41*4882a593Smuzhiyun 	struct ccb_exec_result exec;
42*4882a593Smuzhiyun 	struct ccb_info_result info;
43*4882a593Smuzhiyun 	struct ccb_kill_result kill;
44*4882a593Smuzhiyun };
45*4882a593Smuzhiyun 
46*4882a593Smuzhiyun #define	DAX_MMAP_LEN		(16 * 1024)
47*4882a593Smuzhiyun #define	DAX_MAX_CCBS		15
48*4882a593Smuzhiyun #define	DAX_CCB_BUF_MAXLEN	(DAX_MAX_CCBS * 64)
49*4882a593Smuzhiyun #define	DAX_NAME		"oradax"
50*4882a593Smuzhiyun 
51*4882a593Smuzhiyun /* CCB_EXEC status */
52*4882a593Smuzhiyun #define	DAX_SUBMIT_OK			0
53*4882a593Smuzhiyun #define	DAX_SUBMIT_ERR_RETRY		1
54*4882a593Smuzhiyun #define	DAX_SUBMIT_ERR_WOULDBLOCK	2
55*4882a593Smuzhiyun #define	DAX_SUBMIT_ERR_BUSY		3
56*4882a593Smuzhiyun #define	DAX_SUBMIT_ERR_THR_INIT		4
57*4882a593Smuzhiyun #define	DAX_SUBMIT_ERR_ARG_INVAL	5
58*4882a593Smuzhiyun #define	DAX_SUBMIT_ERR_CCB_INVAL	6
59*4882a593Smuzhiyun #define	DAX_SUBMIT_ERR_NO_CA_AVAIL	7
60*4882a593Smuzhiyun #define	DAX_SUBMIT_ERR_CCB_ARR_MMU_MISS	8
61*4882a593Smuzhiyun #define	DAX_SUBMIT_ERR_NOMAP		9
62*4882a593Smuzhiyun #define	DAX_SUBMIT_ERR_NOACCESS		10
63*4882a593Smuzhiyun #define	DAX_SUBMIT_ERR_TOOMANY		11
64*4882a593Smuzhiyun #define	DAX_SUBMIT_ERR_UNAVAIL		12
65*4882a593Smuzhiyun #define	DAX_SUBMIT_ERR_INTERNAL		13
66*4882a593Smuzhiyun 
67*4882a593Smuzhiyun /* CCB_INFO states - must match HV_CCB_STATE_* definitions */
68*4882a593Smuzhiyun #define	DAX_CCB_COMPLETED	0
69*4882a593Smuzhiyun #define	DAX_CCB_ENQUEUED	1
70*4882a593Smuzhiyun #define	DAX_CCB_INPROGRESS	2
71*4882a593Smuzhiyun #define	DAX_CCB_NOTFOUND	3
72*4882a593Smuzhiyun 
73*4882a593Smuzhiyun /* CCB_KILL actions - must match HV_CCB_KILL_* definitions */
74*4882a593Smuzhiyun #define	DAX_KILL_COMPLETED	0
75*4882a593Smuzhiyun #define	DAX_KILL_DEQUEUED	1
76*4882a593Smuzhiyun #define	DAX_KILL_KILLED		2
77*4882a593Smuzhiyun #define	DAX_KILL_NOTFOUND	3
78*4882a593Smuzhiyun 
79*4882a593Smuzhiyun #endif /* _ORADAX_H */
80