diff options
author | Cornelia Huck <cornelia.huck@de.ibm.com> | 2007-10-12 10:11:16 -0400 |
---|---|---|
committer | Martin Schwidefsky <schwidefsky@de.ibm.com> | 2007-10-12 10:12:59 -0400 |
commit | c02087162af5d8880ff2d688999d71e1bfa16f2f (patch) | |
tree | 5d4250db2ba2225f417f634eebb404311bf60402 /include/asm-s390/cmb.h | |
parent | fc5019c5c7067bcea1e49fe9cd5190285f0c8927 (diff) |
[S390] cio: Kerneldoc comments for cmf.
- Fix existing kerneldoc-style comments.
- Move descriptions of functions from cmb.h to cmf.c.
Signed-off-by: Cornelia Huck <cornelia.huck@de.ibm.com>
Signed-off-by: Martin Schwidefsky <schwidefsky@de.ibm.com>
Signed-off-by: Heiko Carstens <heiko.carstens@de.ibm.com>
Diffstat (limited to 'include/asm-s390/cmb.h')
-rw-r--r-- | include/asm-s390/cmb.h | 65 |
1 files changed, 15 insertions, 50 deletions
diff --git a/include/asm-s390/cmb.h b/include/asm-s390/cmb.h index 2e84eebaf8f4..50196857d27a 100644 --- a/include/asm-s390/cmb.h +++ b/include/asm-s390/cmb.h | |||
@@ -1,29 +1,29 @@ | |||
1 | #ifndef S390_CMB_H | 1 | #ifndef S390_CMB_H |
2 | #define S390_CMB_H | 2 | #define S390_CMB_H |
3 | /** | 3 | /** |
4 | * struct cmbdata -- channel measurement block data for user space | 4 | * struct cmbdata - channel measurement block data for user space |
5 | * @size: size of the stored data | ||
6 | * @elapsed_time: time since last sampling | ||
7 | * @ssch_rsch_count: number of ssch and rsch | ||
8 | * @sample_count: number of samples | ||
9 | * @device_connect_time: time of device connect | ||
10 | * @function_pending_time: time of function pending | ||
11 | * @device_disconnect_time: time of device disconnect | ||
12 | * @control_unit_queuing_time: time of control unit queuing | ||
13 | * @device_active_only_time: time of device active only | ||
14 | * @device_busy_time: time of device busy (ext. format) | ||
15 | * @initial_command_response_time: initial command response time (ext. format) | ||
5 | * | 16 | * |
6 | * @size: size of the stored data | 17 | * All values are stored as 64 bit for simplicity, especially |
7 | * @ssch_rsch_count: XXX | ||
8 | * @sample_count: | ||
9 | * @device_connect_time: | ||
10 | * @function_pending_time: | ||
11 | * @device_disconnect_time: | ||
12 | * @control_unit_queuing_time: | ||
13 | * @device_active_only_time: | ||
14 | * @device_busy_time: | ||
15 | * @initial_command_response_time: | ||
16 | * | ||
17 | * all values are stored as 64 bit for simplicity, especially | ||
18 | * in 32 bit emulation mode. All time values are normalized to | 18 | * in 32 bit emulation mode. All time values are normalized to |
19 | * nanoseconds. | 19 | * nanoseconds. |
20 | * Currently, two formats are known, which differ by the size of | 20 | * Currently, two formats are known, which differ by the size of |
21 | * this structure, i.e. the last two members are only set when | 21 | * this structure, i.e. the last two members are only set when |
22 | * the extended channel measurement facility (first shipped in | 22 | * the extended channel measurement facility (first shipped in |
23 | * z990 machines) is activated. | 23 | * z990 machines) is activated. |
24 | * Potentially, more fields could be added, which results in a | 24 | * Potentially, more fields could be added, which would result in a |
25 | * new ioctl number. | 25 | * new ioctl number. |
26 | **/ | 26 | */ |
27 | struct cmbdata { | 27 | struct cmbdata { |
28 | __u64 size; | 28 | __u64 size; |
29 | __u64 elapsed_time; | 29 | __u64 elapsed_time; |
@@ -49,44 +49,9 @@ struct cmbdata { | |||
49 | 49 | ||
50 | #ifdef __KERNEL__ | 50 | #ifdef __KERNEL__ |
51 | struct ccw_device; | 51 | struct ccw_device; |
52 | /** | ||
53 | * enable_cmf() - switch on the channel measurement for a specific device | ||
54 | * @cdev: The ccw device to be enabled | ||
55 | * returns 0 for success or a negative error value. | ||
56 | * | ||
57 | * Context: | ||
58 | * non-atomic | ||
59 | **/ | ||
60 | extern int enable_cmf(struct ccw_device *cdev); | 52 | extern int enable_cmf(struct ccw_device *cdev); |
61 | |||
62 | /** | ||
63 | * disable_cmf() - switch off the channel measurement for a specific device | ||
64 | * @cdev: The ccw device to be disabled | ||
65 | * returns 0 for success or a negative error value. | ||
66 | * | ||
67 | * Context: | ||
68 | * non-atomic | ||
69 | **/ | ||
70 | extern int disable_cmf(struct ccw_device *cdev); | 53 | extern int disable_cmf(struct ccw_device *cdev); |
71 | |||
72 | /** | ||
73 | * cmf_read() - read one value from the current channel measurement block | ||
74 | * @cmf: the channel to be read | ||
75 | * @index: the name of the value that is read | ||
76 | * | ||
77 | * Context: | ||
78 | * any | ||
79 | **/ | ||
80 | |||
81 | extern u64 cmf_read(struct ccw_device *cdev, int index); | 54 | extern u64 cmf_read(struct ccw_device *cdev, int index); |
82 | /** | ||
83 | * cmf_readall() - read one value from the current channel measurement block | ||
84 | * @cmf: the channel to be read | ||
85 | * @data: a pointer to a data block that will be filled | ||
86 | * | ||
87 | * Context: | ||
88 | * any | ||
89 | **/ | ||
90 | extern int cmf_readall(struct ccw_device *cdev, struct cmbdata *data); | 55 | extern int cmf_readall(struct ccw_device *cdev, struct cmbdata *data); |
91 | 56 | ||
92 | #endif /* __KERNEL__ */ | 57 | #endif /* __KERNEL__ */ |