1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
/*
* libexplain - Explain errno values returned by libc functions
* Copyright (C) 2009 Peter Miller
* Written by Peter Miller <pmiller@opensource.org.au>
*
* 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 3 of the License, or (at
* your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef IOCTL_SCAN_REPORT_H
#define IOCTL_SCAN_REPORT_H
#include <libexplain/ac/stdint.h>
/**
* The report_int function may be used to print a line of results for
* an ioctl request.
*
* @param request
* The name of the ioctl request, suitable for copy-and-paste.
* @param name
* The human readable English name of the result returned by the request.
* @param value
* The value returned by the request.
* @param units
* The units of the request, or NULL if irrelevant.
*/
void report_int(const char *request, const char *name, int value,
const char *units);
/**
* The report_bool function may be used to print a line of results for
* an ioctl request.
*
* @param request
* The name of the ioctl request, suitable for copy-and-paste.
* @param name
* The human readable English name of the result returned by the request.
* @param value
* The value returned by the request.
* @param units
* The units of the request, or NULL if irrelevant.
*/
void report_bool(const char *request, const char *name, int value);
/**
* The report_long function may be used to print a line of results for
* an ioctl request.
*
* @param request
* The name of the ioctl request, suitable for copy-and-paste.
* @param name
* The human readable English name of the result returned by the request.
* @param value
* The value returned by the request.
* @param units
* The units of the request, or NULL if irrelevant.
*/
void report_long(const char *request, const char *name, long value,
const char *units);
/**
* The report_ushort function may be used to print a line of results for
* an ioctl request.
*
* @param request
* The name of the ioctl request, suitable for copy-and-paste.
* @param name
* The human readable English name of the result returned by the request.
* @param value
* The value returned by the request.
* @param units
* The units of the request, or NULL if irrelevant.
*/
void report_ushort(const char *request, const char *name, unsigned short value,
const char *units);
/**
* The report_uint64 function may be used to print a line of results for
* an ioctl request.
*
* @param request
* The name of the ioctl request, suitable for copy-and-paste.
* @param name
* The human readable English name of the result returned by the request.
* @param value
* The value returned by the request.
* @param units
* The units of the request, or NULL if irrelevant.
*/
void report_uint64(const char *request, const char *name, uint64_t value,
const char *units);
/**
* The report function may be used to print a line of results for an
* ioctl request. Usually is more appropriate to use a type-specfic
* variant, for consistent presentation.
*
* @param request
* The name of the ioctl request, suitable for copy-and-paste.
* @param name
* The human readable English name of the result returned by the request.
* @param value
* The value returned by the request.
*/
void report(const char *request, const char *name, const char *value);
/**
* The report_semi_auto function is used to run an ioctl and print the
* returned data. All of the data allocation and de-allocation is
* taken care of automagically.
*
* @param fildes
* The file descriptor to run the request against.
* @param request
* The request to run.
*/
void report_semi_auto(int fildes, int request);
#endif /* IOCTL_SCAN_REPORT_H */
|
