xref: /OK3568_Linux_fs/kernel/include/uapi/linux/raid/md_u.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun    md_u.h : user <=> kernel API between Linux raidtools and RAID drivers
4*4882a593Smuzhiyun           Copyright (C) 1998 Ingo Molnar
5*4882a593Smuzhiyun 
6*4882a593Smuzhiyun    This program is free software; you can redistribute it and/or modify
7*4882a593Smuzhiyun    it under the terms of the GNU General Public License as published by
8*4882a593Smuzhiyun    the Free Software Foundation; either version 2, or (at your option)
9*4882a593Smuzhiyun    any later version.
10*4882a593Smuzhiyun 
11*4882a593Smuzhiyun    You should have received a copy of the GNU General Public License
12*4882a593Smuzhiyun    (for example /usr/src/linux/COPYING); if not, write to the Free
13*4882a593Smuzhiyun    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
14*4882a593Smuzhiyun */
15*4882a593Smuzhiyun 
16*4882a593Smuzhiyun #ifndef _UAPI_MD_U_H
17*4882a593Smuzhiyun #define _UAPI_MD_U_H
18*4882a593Smuzhiyun 
19*4882a593Smuzhiyun /*
20*4882a593Smuzhiyun  * Different major versions are not compatible.
21*4882a593Smuzhiyun  * Different minor versions are only downward compatible.
22*4882a593Smuzhiyun  * Different patchlevel versions are downward and upward compatible.
23*4882a593Smuzhiyun  */
24*4882a593Smuzhiyun #define MD_MAJOR_VERSION                0
25*4882a593Smuzhiyun #define MD_MINOR_VERSION                90
26*4882a593Smuzhiyun /*
27*4882a593Smuzhiyun  * MD_PATCHLEVEL_VERSION indicates kernel functionality.
28*4882a593Smuzhiyun  * >=1 means different superblock formats are selectable using SET_ARRAY_INFO
29*4882a593Smuzhiyun  *     and major_version/minor_version accordingly
30*4882a593Smuzhiyun  * >=2 means that Internal bitmaps are supported by setting MD_SB_BITMAP_PRESENT
31*4882a593Smuzhiyun  *     in the super status byte
32*4882a593Smuzhiyun  * >=3 means that bitmap superblock version 4 is supported, which uses
33*4882a593Smuzhiyun  *     little-ending representation rather than host-endian
34*4882a593Smuzhiyun  */
35*4882a593Smuzhiyun #define MD_PATCHLEVEL_VERSION           3
36*4882a593Smuzhiyun 
37*4882a593Smuzhiyun /* ioctls */
38*4882a593Smuzhiyun 
39*4882a593Smuzhiyun /* status */
40*4882a593Smuzhiyun #define RAID_VERSION		_IOR (MD_MAJOR, 0x10, mdu_version_t)
41*4882a593Smuzhiyun #define GET_ARRAY_INFO		_IOR (MD_MAJOR, 0x11, mdu_array_info_t)
42*4882a593Smuzhiyun #define GET_DISK_INFO		_IOR (MD_MAJOR, 0x12, mdu_disk_info_t)
43*4882a593Smuzhiyun #define RAID_AUTORUN		_IO (MD_MAJOR, 0x14)
44*4882a593Smuzhiyun #define GET_BITMAP_FILE		_IOR (MD_MAJOR, 0x15, mdu_bitmap_file_t)
45*4882a593Smuzhiyun 
46*4882a593Smuzhiyun /* configuration */
47*4882a593Smuzhiyun #define CLEAR_ARRAY		_IO (MD_MAJOR, 0x20)
48*4882a593Smuzhiyun #define ADD_NEW_DISK		_IOW (MD_MAJOR, 0x21, mdu_disk_info_t)
49*4882a593Smuzhiyun #define HOT_REMOVE_DISK		_IO (MD_MAJOR, 0x22)
50*4882a593Smuzhiyun #define SET_ARRAY_INFO		_IOW (MD_MAJOR, 0x23, mdu_array_info_t)
51*4882a593Smuzhiyun #define SET_DISK_INFO		_IO (MD_MAJOR, 0x24)
52*4882a593Smuzhiyun #define WRITE_RAID_INFO		_IO (MD_MAJOR, 0x25)
53*4882a593Smuzhiyun #define UNPROTECT_ARRAY		_IO (MD_MAJOR, 0x26)
54*4882a593Smuzhiyun #define PROTECT_ARRAY		_IO (MD_MAJOR, 0x27)
55*4882a593Smuzhiyun #define HOT_ADD_DISK		_IO (MD_MAJOR, 0x28)
56*4882a593Smuzhiyun #define SET_DISK_FAULTY		_IO (MD_MAJOR, 0x29)
57*4882a593Smuzhiyun #define HOT_GENERATE_ERROR	_IO (MD_MAJOR, 0x2a)
58*4882a593Smuzhiyun #define SET_BITMAP_FILE		_IOW (MD_MAJOR, 0x2b, int)
59*4882a593Smuzhiyun 
60*4882a593Smuzhiyun /* usage */
61*4882a593Smuzhiyun #define RUN_ARRAY		_IOW (MD_MAJOR, 0x30, mdu_param_t)
62*4882a593Smuzhiyun /*  0x31 was START_ARRAY  */
63*4882a593Smuzhiyun #define STOP_ARRAY		_IO (MD_MAJOR, 0x32)
64*4882a593Smuzhiyun #define STOP_ARRAY_RO		_IO (MD_MAJOR, 0x33)
65*4882a593Smuzhiyun #define RESTART_ARRAY_RW	_IO (MD_MAJOR, 0x34)
66*4882a593Smuzhiyun #define CLUSTERED_DISK_NACK	_IO (MD_MAJOR, 0x35)
67*4882a593Smuzhiyun 
68*4882a593Smuzhiyun /* 63 partitions with the alternate major number (mdp) */
69*4882a593Smuzhiyun #define MdpMinorShift 6
70*4882a593Smuzhiyun 
71*4882a593Smuzhiyun typedef struct mdu_version_s {
72*4882a593Smuzhiyun 	int major;
73*4882a593Smuzhiyun 	int minor;
74*4882a593Smuzhiyun 	int patchlevel;
75*4882a593Smuzhiyun } mdu_version_t;
76*4882a593Smuzhiyun 
77*4882a593Smuzhiyun typedef struct mdu_array_info_s {
78*4882a593Smuzhiyun 	/*
79*4882a593Smuzhiyun 	 * Generic constant information
80*4882a593Smuzhiyun 	 */
81*4882a593Smuzhiyun 	int major_version;
82*4882a593Smuzhiyun 	int minor_version;
83*4882a593Smuzhiyun 	int patch_version;
84*4882a593Smuzhiyun 	unsigned int ctime;
85*4882a593Smuzhiyun 	int level;
86*4882a593Smuzhiyun 	int size;
87*4882a593Smuzhiyun 	int nr_disks;
88*4882a593Smuzhiyun 	int raid_disks;
89*4882a593Smuzhiyun 	int md_minor;
90*4882a593Smuzhiyun 	int not_persistent;
91*4882a593Smuzhiyun 
92*4882a593Smuzhiyun 	/*
93*4882a593Smuzhiyun 	 * Generic state information
94*4882a593Smuzhiyun 	 */
95*4882a593Smuzhiyun 	unsigned int utime;	/*  0 Superblock update time		      */
96*4882a593Smuzhiyun 	int state;		/*  1 State bits (clean, ...)		      */
97*4882a593Smuzhiyun 	int active_disks;	/*  2 Number of currently active disks	      */
98*4882a593Smuzhiyun 	int working_disks;	/*  3 Number of working disks		      */
99*4882a593Smuzhiyun 	int failed_disks;	/*  4 Number of failed disks		      */
100*4882a593Smuzhiyun 	int spare_disks;	/*  5 Number of spare disks		      */
101*4882a593Smuzhiyun 
102*4882a593Smuzhiyun 	/*
103*4882a593Smuzhiyun 	 * Personality information
104*4882a593Smuzhiyun 	 */
105*4882a593Smuzhiyun 	int layout;		/*  0 the array's physical layout	      */
106*4882a593Smuzhiyun 	int chunk_size;	/*  1 chunk size in bytes		      */
107*4882a593Smuzhiyun 
108*4882a593Smuzhiyun } mdu_array_info_t;
109*4882a593Smuzhiyun 
110*4882a593Smuzhiyun /* non-obvious values for 'level' */
111*4882a593Smuzhiyun #define	LEVEL_MULTIPATH		(-4)
112*4882a593Smuzhiyun #define	LEVEL_LINEAR		(-1)
113*4882a593Smuzhiyun #define	LEVEL_FAULTY		(-5)
114*4882a593Smuzhiyun 
115*4882a593Smuzhiyun /* we need a value for 'no level specified' and 0
116*4882a593Smuzhiyun  * means 'raid0', so we need something else.  This is
117*4882a593Smuzhiyun  * for internal use only
118*4882a593Smuzhiyun  */
119*4882a593Smuzhiyun #define	LEVEL_NONE		(-1000000)
120*4882a593Smuzhiyun 
121*4882a593Smuzhiyun typedef struct mdu_disk_info_s {
122*4882a593Smuzhiyun 	/*
123*4882a593Smuzhiyun 	 * configuration/status of one particular disk
124*4882a593Smuzhiyun 	 */
125*4882a593Smuzhiyun 	int number;
126*4882a593Smuzhiyun 	int major;
127*4882a593Smuzhiyun 	int minor;
128*4882a593Smuzhiyun 	int raid_disk;
129*4882a593Smuzhiyun 	int state;
130*4882a593Smuzhiyun 
131*4882a593Smuzhiyun } mdu_disk_info_t;
132*4882a593Smuzhiyun 
133*4882a593Smuzhiyun typedef struct mdu_start_info_s {
134*4882a593Smuzhiyun 	/*
135*4882a593Smuzhiyun 	 * configuration/status of one particular disk
136*4882a593Smuzhiyun 	 */
137*4882a593Smuzhiyun 	int major;
138*4882a593Smuzhiyun 	int minor;
139*4882a593Smuzhiyun 	int raid_disk;
140*4882a593Smuzhiyun 	int state;
141*4882a593Smuzhiyun 
142*4882a593Smuzhiyun } mdu_start_info_t;
143*4882a593Smuzhiyun 
144*4882a593Smuzhiyun typedef struct mdu_bitmap_file_s
145*4882a593Smuzhiyun {
146*4882a593Smuzhiyun 	char pathname[4096];
147*4882a593Smuzhiyun } mdu_bitmap_file_t;
148*4882a593Smuzhiyun 
149*4882a593Smuzhiyun typedef struct mdu_param_s
150*4882a593Smuzhiyun {
151*4882a593Smuzhiyun 	int			personality;	/* 1,2,3,4 */
152*4882a593Smuzhiyun 	int			chunk_size;	/* in bytes */
153*4882a593Smuzhiyun 	int			max_fault;	/* unused for now */
154*4882a593Smuzhiyun } mdu_param_t;
155*4882a593Smuzhiyun 
156*4882a593Smuzhiyun #endif /* _UAPI_MD_U_H */
157