xref: /OK3568_Linux_fs/kernel/drivers/s390/char/hmcdrv_ftp.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  *    SE/HMC Drive FTP Services
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  *    Copyright IBM Corp. 2013
6*4882a593Smuzhiyun  *    Author(s): Ralf Hoppe (rhoppe@de.ibm.com)
7*4882a593Smuzhiyun  */
8*4882a593Smuzhiyun 
9*4882a593Smuzhiyun #ifndef __HMCDRV_FTP_H__
10*4882a593Smuzhiyun #define __HMCDRV_FTP_H__
11*4882a593Smuzhiyun 
12*4882a593Smuzhiyun #include <linux/types.h> /* size_t, loff_t */
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun /*
15*4882a593Smuzhiyun  * HMC drive FTP Service max. length of path (w/ EOS)
16*4882a593Smuzhiyun  */
17*4882a593Smuzhiyun #define HMCDRV_FTP_FIDENT_MAX 192
18*4882a593Smuzhiyun 
19*4882a593Smuzhiyun /**
20*4882a593Smuzhiyun  * enum hmcdrv_ftp_cmdid - HMC drive FTP commands
21*4882a593Smuzhiyun  * @HMCDRV_FTP_NOOP: do nothing (only for probing)
22*4882a593Smuzhiyun  * @HMCDRV_FTP_GET: read a file
23*4882a593Smuzhiyun  * @HMCDRV_FTP_PUT: (over-) write a file
24*4882a593Smuzhiyun  * @HMCDRV_FTP_APPEND: append to a file
25*4882a593Smuzhiyun  * @HMCDRV_FTP_DIR: list directory long (ls -l)
26*4882a593Smuzhiyun  * @HMCDRV_FTP_NLIST: list files, no directories (name list)
27*4882a593Smuzhiyun  * @HMCDRV_FTP_DELETE: delete a file
28*4882a593Smuzhiyun  * @HMCDRV_FTP_CANCEL: cancel operation (SCLP/LPAR only)
29*4882a593Smuzhiyun  */
30*4882a593Smuzhiyun enum hmcdrv_ftp_cmdid {
31*4882a593Smuzhiyun 	HMCDRV_FTP_NOOP = 0,
32*4882a593Smuzhiyun 	HMCDRV_FTP_GET = 1,
33*4882a593Smuzhiyun 	HMCDRV_FTP_PUT = 2,
34*4882a593Smuzhiyun 	HMCDRV_FTP_APPEND = 3,
35*4882a593Smuzhiyun 	HMCDRV_FTP_DIR = 4,
36*4882a593Smuzhiyun 	HMCDRV_FTP_NLIST = 5,
37*4882a593Smuzhiyun 	HMCDRV_FTP_DELETE = 6,
38*4882a593Smuzhiyun 	HMCDRV_FTP_CANCEL = 7
39*4882a593Smuzhiyun };
40*4882a593Smuzhiyun 
41*4882a593Smuzhiyun /**
42*4882a593Smuzhiyun  * struct hmcdrv_ftp_cmdspec - FTP command specification
43*4882a593Smuzhiyun  * @id: FTP command ID
44*4882a593Smuzhiyun  * @ofs: offset in file
45*4882a593Smuzhiyun  * @fname: filename (ASCII), null-terminated
46*4882a593Smuzhiyun  * @buf: kernel-space transfer data buffer, 4k aligned
47*4882a593Smuzhiyun  * @len: (max) number of bytes to transfer from/to @buf
48*4882a593Smuzhiyun  */
49*4882a593Smuzhiyun struct hmcdrv_ftp_cmdspec {
50*4882a593Smuzhiyun 	enum hmcdrv_ftp_cmdid id;
51*4882a593Smuzhiyun 	loff_t ofs;
52*4882a593Smuzhiyun 	const char *fname;
53*4882a593Smuzhiyun 	void __kernel *buf;
54*4882a593Smuzhiyun 	size_t len;
55*4882a593Smuzhiyun };
56*4882a593Smuzhiyun 
57*4882a593Smuzhiyun int hmcdrv_ftp_startup(void);
58*4882a593Smuzhiyun void hmcdrv_ftp_shutdown(void);
59*4882a593Smuzhiyun int hmcdrv_ftp_probe(void);
60*4882a593Smuzhiyun ssize_t hmcdrv_ftp_do(const struct hmcdrv_ftp_cmdspec *ftp);
61*4882a593Smuzhiyun ssize_t hmcdrv_ftp_cmd(char __kernel *cmd, loff_t offset,
62*4882a593Smuzhiyun 		       char __user *buf, size_t len);
63*4882a593Smuzhiyun 
64*4882a593Smuzhiyun #endif	 /* __HMCDRV_FTP_H__ */
65