diff options
Diffstat (limited to 'include/linux/kfifo.h')
-rw-r--r-- | include/linux/kfifo.h | 31 |
1 files changed, 15 insertions, 16 deletions
diff --git a/include/linux/kfifo.h b/include/linux/kfifo.h index 486e8ad3bb5..3d44e9c65a8 100644 --- a/include/linux/kfifo.h +++ b/include/linux/kfifo.h | |||
@@ -69,8 +69,8 @@ struct kfifo { | |||
69 | * @name: name of the declared kfifo datatype | 69 | * @name: name of the declared kfifo datatype |
70 | * @size: size of the fifo buffer | 70 | * @size: size of the fifo buffer |
71 | * | 71 | * |
72 | * Note: the macro can be used inside struct or union declaration | 72 | * Note1: the macro can be used inside struct or union declaration |
73 | * Note: the macro creates two objects: | 73 | * Note2: the macro creates two objects: |
74 | * A kfifo object with the given name and a buffer for the kfifo | 74 | * A kfifo object with the given name and a buffer for the kfifo |
75 | * object named name##kfifo_buffer | 75 | * object named name##kfifo_buffer |
76 | */ | 76 | */ |
@@ -83,7 +83,6 @@ union { \ | |||
83 | /** | 83 | /** |
84 | * INIT_KFIFO - Initialize a kfifo declared by DECLARED_KFIFO | 84 | * INIT_KFIFO - Initialize a kfifo declared by DECLARED_KFIFO |
85 | * @name: name of the declared kfifo datatype | 85 | * @name: name of the declared kfifo datatype |
86 | * @size: size of the fifo buffer | ||
87 | */ | 86 | */ |
88 | #define INIT_KFIFO(name) \ | 87 | #define INIT_KFIFO(name) \ |
89 | name = __kfifo_initializer(sizeof(name##kfifo_buffer) - \ | 88 | name = __kfifo_initializer(sizeof(name##kfifo_buffer) - \ |
@@ -94,8 +93,8 @@ union { \ | |||
94 | * @name: name of the declared kfifo datatype | 93 | * @name: name of the declared kfifo datatype |
95 | * @size: size of the fifo buffer | 94 | * @size: size of the fifo buffer |
96 | * | 95 | * |
97 | * Note: the macro can be used for global and local kfifo data type variables | 96 | * Note1: the macro can be used for global and local kfifo data type variables |
98 | * Note: the macro creates two objects: | 97 | * Note2: the macro creates two objects: |
99 | * A kfifo object with the given name and a buffer for the kfifo | 98 | * A kfifo object with the given name and a buffer for the kfifo |
100 | * object named name##kfifo_buffer | 99 | * object named name##kfifo_buffer |
101 | */ | 100 | */ |
@@ -249,7 +248,7 @@ extern __must_check unsigned int kfifo_from_user(struct kfifo *fifo, | |||
249 | extern __must_check unsigned int kfifo_to_user(struct kfifo *fifo, | 248 | extern __must_check unsigned int kfifo_to_user(struct kfifo *fifo, |
250 | void __user *to, unsigned int n); | 249 | void __user *to, unsigned int n); |
251 | 250 | ||
252 | /** | 251 | /* |
253 | * __kfifo_add_out internal helper function for updating the out offset | 252 | * __kfifo_add_out internal helper function for updating the out offset |
254 | */ | 253 | */ |
255 | static inline void __kfifo_add_out(struct kfifo *fifo, | 254 | static inline void __kfifo_add_out(struct kfifo *fifo, |
@@ -259,7 +258,7 @@ static inline void __kfifo_add_out(struct kfifo *fifo, | |||
259 | fifo->out += off; | 258 | fifo->out += off; |
260 | } | 259 | } |
261 | 260 | ||
262 | /** | 261 | /* |
263 | * __kfifo_add_in internal helper function for updating the in offset | 262 | * __kfifo_add_in internal helper function for updating the in offset |
264 | */ | 263 | */ |
265 | static inline void __kfifo_add_in(struct kfifo *fifo, | 264 | static inline void __kfifo_add_in(struct kfifo *fifo, |
@@ -269,7 +268,7 @@ static inline void __kfifo_add_in(struct kfifo *fifo, | |||
269 | fifo->in += off; | 268 | fifo->in += off; |
270 | } | 269 | } |
271 | 270 | ||
272 | /** | 271 | /* |
273 | * __kfifo_off internal helper function for calculating the index of a | 272 | * __kfifo_off internal helper function for calculating the index of a |
274 | * given offeset | 273 | * given offeset |
275 | */ | 274 | */ |
@@ -278,7 +277,7 @@ static inline unsigned int __kfifo_off(struct kfifo *fifo, unsigned int off) | |||
278 | return off & (fifo->size - 1); | 277 | return off & (fifo->size - 1); |
279 | } | 278 | } |
280 | 279 | ||
281 | /** | 280 | /* |
282 | * __kfifo_peek_n internal helper function for determinate the length of | 281 | * __kfifo_peek_n internal helper function for determinate the length of |
283 | * the next record in the fifo | 282 | * the next record in the fifo |
284 | */ | 283 | */ |
@@ -299,7 +298,7 @@ static inline unsigned int __kfifo_peek_n(struct kfifo *fifo, | |||
299 | #undef __KFIFO_GET | 298 | #undef __KFIFO_GET |
300 | } | 299 | } |
301 | 300 | ||
302 | /** | 301 | /* |
303 | * __kfifo_poke_n internal helper function for storing the length of | 302 | * __kfifo_poke_n internal helper function for storing the length of |
304 | * the next record into the fifo | 303 | * the next record into the fifo |
305 | */ | 304 | */ |
@@ -319,7 +318,7 @@ static inline void __kfifo_poke_n(struct kfifo *fifo, | |||
319 | #undef __KFIFO_PUT | 318 | #undef __KFIFO_PUT |
320 | } | 319 | } |
321 | 320 | ||
322 | /** | 321 | /* |
323 | * __kfifo_in_... internal functions for put date into the fifo | 322 | * __kfifo_in_... internal functions for put date into the fifo |
324 | * do not call it directly, use kfifo_in_rec() instead | 323 | * do not call it directly, use kfifo_in_rec() instead |
325 | */ | 324 | */ |
@@ -367,7 +366,7 @@ static inline __must_check unsigned int kfifo_in_rec(struct kfifo *fifo, | |||
367 | return __kfifo_in_rec(fifo, from, n, recsize); | 366 | return __kfifo_in_rec(fifo, from, n, recsize); |
368 | } | 367 | } |
369 | 368 | ||
370 | /** | 369 | /* |
371 | * __kfifo_out_... internal functions for get date from the fifo | 370 | * __kfifo_out_... internal functions for get date from the fifo |
372 | * do not call it directly, use kfifo_out_rec() instead | 371 | * do not call it directly, use kfifo_out_rec() instead |
373 | */ | 372 | */ |
@@ -425,7 +424,7 @@ static inline __must_check unsigned int kfifo_out_rec(struct kfifo *fifo, | |||
425 | return __kfifo_out_rec(fifo, to, n, recsize, total); | 424 | return __kfifo_out_rec(fifo, to, n, recsize, total); |
426 | } | 425 | } |
427 | 426 | ||
428 | /** | 427 | /* |
429 | * __kfifo_from_user_... internal functions for transfer from user space into | 428 | * __kfifo_from_user_... internal functions for transfer from user space into |
430 | * the fifo. do not call it directly, use kfifo_from_user_rec() instead | 429 | * the fifo. do not call it directly, use kfifo_from_user_rec() instead |
431 | */ | 430 | */ |
@@ -474,7 +473,7 @@ static inline __must_check unsigned int kfifo_from_user_rec(struct kfifo *fifo, | |||
474 | return __kfifo_from_user_rec(fifo, from, n, recsize); | 473 | return __kfifo_from_user_rec(fifo, from, n, recsize); |
475 | } | 474 | } |
476 | 475 | ||
477 | /** | 476 | /* |
478 | * __kfifo_to_user_... internal functions for transfer fifo data into user space | 477 | * __kfifo_to_user_... internal functions for transfer fifo data into user space |
479 | * do not call it directly, use kfifo_to_user_rec() instead | 478 | * do not call it directly, use kfifo_to_user_rec() instead |
480 | */ | 479 | */ |
@@ -533,7 +532,7 @@ static inline __must_check unsigned int kfifo_to_user_rec(struct kfifo *fifo, | |||
533 | return __kfifo_to_user_rec(fifo, to, n, recsize, total); | 532 | return __kfifo_to_user_rec(fifo, to, n, recsize, total); |
534 | } | 533 | } |
535 | 534 | ||
536 | /** | 535 | /* |
537 | * __kfifo_peek_... internal functions for peek into the next fifo record | 536 | * __kfifo_peek_... internal functions for peek into the next fifo record |
538 | * do not call it directly, use kfifo_peek_rec() instead | 537 | * do not call it directly, use kfifo_peek_rec() instead |
539 | */ | 538 | */ |
@@ -557,7 +556,7 @@ static inline __must_check unsigned int kfifo_peek_rec(struct kfifo *fifo, | |||
557 | return __kfifo_peek_n(fifo, recsize); | 556 | return __kfifo_peek_n(fifo, recsize); |
558 | } | 557 | } |
559 | 558 | ||
560 | /** | 559 | /* |
561 | * __kfifo_skip_... internal functions for skip the next fifo record | 560 | * __kfifo_skip_... internal functions for skip the next fifo record |
562 | * do not call it directly, use kfifo_skip_rec() instead | 561 | * do not call it directly, use kfifo_skip_rec() instead |
563 | */ | 562 | */ |