xref: /openbmc/linux/arch/s390/include/asm/cpcmd.h (revision a2cce7a9)
1 /*
2  *  S390 version
3  *    Copyright IBM Corp. 1999
4  *    Author(s): Martin Schwidefsky (schwidefsky@de.ibm.com),
5  *               Christian Borntraeger (cborntra@de.ibm.com),
6  */
7 
8 #ifndef _ASM_S390_CPCMD_H
9 #define _ASM_S390_CPCMD_H
10 
11 /*
12  * the lowlevel function for cpcmd
13  * the caller of __cpcmd has to ensure that the response buffer is below 2 GB
14  */
15 extern int __cpcmd(const char *cmd, char *response, int rlen, int *response_code);
16 
17 /*
18  * cpcmd is the in-kernel interface for issuing CP commands
19  *
20  * cmd:		null-terminated command string, max 240 characters
21  * response:	response buffer for VM's textual response
22  * rlen:	size of the response buffer, cpcmd will not exceed this size
23  *		but will cap the output, if its too large. Everything that
24  *		did not fit into the buffer will be silently dropped
25  * response_code: return pointer for VM's error code
26  * return value: the size of the response. The caller can check if the buffer
27  *		was large enough by comparing the return value and rlen
28  * NOTE: If the response buffer is not below 2 GB, cpcmd can sleep
29  */
30 extern int cpcmd(const char *cmd, char *response, int rlen, int *response_code);
31 
32 #endif /* _ASM_S390_CPCMD_H */
33