diff options
author | Felix Beck <felix.beck@de.ibm.com> | 2008-04-17 01:46:28 -0400 |
---|---|---|
committer | Heiko Carstens <heiko.carstens@de.ibm.com> | 2008-04-17 01:47:06 -0400 |
commit | 1749a81d629b1295b38071914728cc2e72066f4d (patch) | |
tree | 8918ddaa31fe27bb385fd70b8bd03cc6dbb9782a /drivers/s390/crypto/ap_bus.h | |
parent | 3f12ebce6a004c8e9bf639801842f67e578ee7c6 (diff) |
[S390] zcrypt: Comments and kernel-doc cleanup
Comments, which suggested to be kernel-doc but were not in the right
formatting, have been corrected. Additionally some minor cleanup in
the comments has been done.
Signed-off-by: Felix Beck <felix.beck@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 'drivers/s390/crypto/ap_bus.h')
-rw-r--r-- | drivers/s390/crypto/ap_bus.h | 15 |
1 files changed, 12 insertions, 3 deletions
diff --git a/drivers/s390/crypto/ap_bus.h b/drivers/s390/crypto/ap_bus.h index 87c2d6442875..c1e1200c43fc 100644 --- a/drivers/s390/crypto/ap_bus.h +++ b/drivers/s390/crypto/ap_bus.h | |||
@@ -50,6 +50,15 @@ typedef unsigned int ap_qid_t; | |||
50 | #define AP_QID_QUEUE(_qid) ((_qid) & 15) | 50 | #define AP_QID_QUEUE(_qid) ((_qid) & 15) |
51 | 51 | ||
52 | /** | 52 | /** |
53 | * structy ap_queue_status - Holds the AP queue status. | ||
54 | * @queue_empty: Shows if queue is empty | ||
55 | * @replies_waiting: Waiting replies | ||
56 | * @queue_full: Is 1 if the queue is full | ||
57 | * @pad: A 4 bit pad | ||
58 | * @int_enabled: Shows if interrupts are enabled for the AP | ||
59 | * @response_conde: Holds the 8 bit response code | ||
60 | * @pad2: A 16 bit pad | ||
61 | * | ||
53 | * The ap queue status word is returned by all three AP functions | 62 | * The ap queue status word is returned by all three AP functions |
54 | * (PQAP, NQAP and DQAP). There's a set of flags in the first | 63 | * (PQAP, NQAP and DQAP). There's a set of flags in the first |
55 | * byte, followed by a 1 byte response code. | 64 | * byte, followed by a 1 byte response code. |
@@ -75,7 +84,7 @@ struct ap_queue_status { | |||
75 | #define AP_RESPONSE_NO_FIRST_PART 0x13 | 84 | #define AP_RESPONSE_NO_FIRST_PART 0x13 |
76 | #define AP_RESPONSE_MESSAGE_TOO_BIG 0x15 | 85 | #define AP_RESPONSE_MESSAGE_TOO_BIG 0x15 |
77 | 86 | ||
78 | /** | 87 | /* |
79 | * Known device types | 88 | * Known device types |
80 | */ | 89 | */ |
81 | #define AP_DEVICE_TYPE_PCICC 3 | 90 | #define AP_DEVICE_TYPE_PCICC 3 |
@@ -84,7 +93,7 @@ struct ap_queue_status { | |||
84 | #define AP_DEVICE_TYPE_CEX2A 6 | 93 | #define AP_DEVICE_TYPE_CEX2A 6 |
85 | #define AP_DEVICE_TYPE_CEX2C 7 | 94 | #define AP_DEVICE_TYPE_CEX2C 7 |
86 | 95 | ||
87 | /** | 96 | /* |
88 | * AP reset flag states | 97 | * AP reset flag states |
89 | */ | 98 | */ |
90 | #define AP_RESET_IGNORE 0 /* request timeout will be ignored */ | 99 | #define AP_RESET_IGNORE 0 /* request timeout will be ignored */ |
@@ -152,7 +161,7 @@ struct ap_message { | |||
152 | .dev_type=(dt), \ | 161 | .dev_type=(dt), \ |
153 | .match_flags=AP_DEVICE_ID_MATCH_DEVICE_TYPE, | 162 | .match_flags=AP_DEVICE_ID_MATCH_DEVICE_TYPE, |
154 | 163 | ||
155 | /** | 164 | /* |
156 | * Note: don't use ap_send/ap_recv after using ap_queue_message | 165 | * Note: don't use ap_send/ap_recv after using ap_queue_message |
157 | * for the first time. Otherwise the ap message queue will get | 166 | * for the first time. Otherwise the ap message queue will get |
158 | * confused. | 167 | * confused. |