net/iucv: clean up iucv kernel-doc warnings

+111 -323

2 changed files

expand all

include

net

iucv

iucv.h

net

iucv

iucv.c

+3 -204

include/net/iucv/iucv.h

··· 195 195 struct list_head paths; 196 196 }; 197 197 198 - /** 199 - * iucv_register: 200 - * @handler: address of iucv handler structure 201 - * @smp: != 0 indicates that the handler can deal with out of order messages 202 - * 203 - * Registers a driver with IUCV. 204 - * 205 - * Returns: 0 on success, -ENOMEM if the memory allocation for the pathid 206 - * table failed, or -EIO if IUCV_DECLARE_BUFFER failed on all cpus. 207 - */ 208 198 int iucv_register(struct iucv_handler *handler, int smp); 199 + void iucv_unregister(struct iucv_handler *handler, int smp); 209 200 210 201 /** 211 - * iucv_unregister 212 - * @handler: address of iucv handler structure 213 - * @smp: != 0 indicates that the handler can deal with out of order messages 214 - * 215 - * Unregister driver from IUCV. 216 - */ 217 - void iucv_unregister(struct iucv_handler *handle, int smp); 218 - 219 - /** 220 - * iucv_path_alloc 202 + * iucv_path_alloc - Allocate a new path structure for use with iucv_connect. 221 203 * @msglim: initial message limit 222 204 * @flags: initial flags 223 205 * @gfp: kmalloc allocation flag 224 - * 225 - * Allocate a new path structure for use with iucv_connect. 226 206 * 227 207 * Returns: NULL if the memory allocation failed or a pointer to the 228 208 * path structure. ··· 220 240 } 221 241 222 242 /** 223 - * iucv_path_free 243 + * iucv_path_free - Frees a path structure. 224 244 * @path: address of iucv path structure 225 - * 226 - * Frees a path structure. 227 245 */ 228 246 static inline void iucv_path_free(struct iucv_path *path) 229 247 { 230 248 kfree(path); 231 249 } 232 250 233 - /** 234 - * iucv_path_accept 235 - * @path: address of iucv path structure 236 - * @handler: address of iucv handler structure 237 - * @userdata: 16 bytes of data reflected to the communication partner 238 - * @private: private data passed to interrupt handlers for this path 239 - * 240 - * This function is issued after the user received a connection pending 241 - * external interrupt and now wishes to complete the IUCV communication path. 242 - * 243 - * Returns: the result of the CP IUCV call. 244 - */ 245 251 int iucv_path_accept(struct iucv_path *path, struct iucv_handler *handler, 246 252 u8 *userdata, void *private); 247 253 248 - /** 249 - * iucv_path_connect 250 - * @path: address of iucv path structure 251 - * @handler: address of iucv handler structure 252 - * @userid: 8-byte user identification 253 - * @system: 8-byte target system identification 254 - * @userdata: 16 bytes of data reflected to the communication partner 255 - * @private: private data passed to interrupt handlers for this path 256 - * 257 - * This function establishes an IUCV path. Although the connect may complete 258 - * successfully, you are not able to use the path until you receive an IUCV 259 - * Connection Complete external interrupt. 260 - * 261 - * Returns: the result of the CP IUCV call. 262 - */ 263 254 int iucv_path_connect(struct iucv_path *path, struct iucv_handler *handler, 264 255 u8 *userid, u8 *system, u8 *userdata, 265 256 void *private); 266 257 267 - /** 268 - * iucv_path_quiesce: 269 - * @path: address of iucv path structure 270 - * @userdata: 16 bytes of data reflected to the communication partner 271 - * 272 - * This function temporarily suspends incoming messages on an IUCV path. 273 - * You can later reactivate the path by invoking the iucv_resume function. 274 - * 275 - * Returns: the result from the CP IUCV call. 276 - */ 277 258 int iucv_path_quiesce(struct iucv_path *path, u8 *userdata); 278 259 279 - /** 280 - * iucv_path_resume: 281 - * @path: address of iucv path structure 282 - * @userdata: 16 bytes of data reflected to the communication partner 283 - * 284 - * This function resumes incoming messages on an IUCV path that has 285 - * been stopped with iucv_path_quiesce. 286 - * 287 - * Returns: the result from the CP IUCV call. 288 - */ 289 260 int iucv_path_resume(struct iucv_path *path, u8 *userdata); 290 261 291 - /** 292 - * iucv_path_sever 293 - * @path: address of iucv path structure 294 - * @userdata: 16 bytes of data reflected to the communication partner 295 - * 296 - * This function terminates an IUCV path. 297 - * 298 - * Returns: the result from the CP IUCV call. 299 - */ 300 262 int iucv_path_sever(struct iucv_path *path, u8 *userdata); 301 263 302 - /** 303 - * iucv_message_purge 304 - * @path: address of iucv path structure 305 - * @msg: address of iucv msg structure 306 - * @srccls: source class of message 307 - * 308 - * Cancels a message you have sent. 309 - * 310 - * Returns: the result from the CP IUCV call. 311 - */ 312 264 int iucv_message_purge(struct iucv_path *path, struct iucv_message *msg, 313 265 u32 srccls); 314 266 315 - /** 316 - * iucv_message_receive 317 - * @path: address of iucv path structure 318 - * @msg: address of iucv msg structure 319 - * @flags: flags that affect how the message is received (IUCV_IPBUFLST) 320 - * @buffer: address of data buffer or address of struct iucv_array 321 - * @size: length of data buffer 322 - * @residual: 323 - * 324 - * This function receives messages that are being sent to you over 325 - * established paths. This function will deal with RMDATA messages 326 - * embedded in struct iucv_message as well. 327 - * 328 - * Locking: local_bh_enable/local_bh_disable 329 - * 330 - * Returns: the result from the CP IUCV call. 331 - */ 332 267 int iucv_message_receive(struct iucv_path *path, struct iucv_message *msg, 333 268 u8 flags, void *buffer, size_t size, size_t *residual); 334 269 335 - /** 336 - * __iucv_message_receive 337 - * @path: address of iucv path structure 338 - * @msg: address of iucv msg structure 339 - * @flags: flags that affect how the message is received (IUCV_IPBUFLST) 340 - * @buffer: address of data buffer or address of struct iucv_array 341 - * @size: length of data buffer 342 - * @residual: 343 - * 344 - * This function receives messages that are being sent to you over 345 - * established paths. This function will deal with RMDATA messages 346 - * embedded in struct iucv_message as well. 347 - * 348 - * Locking: no locking. 349 - * 350 - * Returns: the result from the CP IUCV call. 351 - */ 352 270 int __iucv_message_receive(struct iucv_path *path, struct iucv_message *msg, 353 271 u8 flags, void *buffer, size_t size, 354 272 size_t *residual); 355 273 356 - /** 357 - * iucv_message_reject 358 - * @path: address of iucv path structure 359 - * @msg: address of iucv msg structure 360 - * 361 - * The reject function refuses a specified message. Between the time you 362 - * are notified of a message and the time that you complete the message, 363 - * the message may be rejected. 364 - * 365 - * Returns: the result from the CP IUCV call. 366 - */ 367 274 int iucv_message_reject(struct iucv_path *path, struct iucv_message *msg); 368 275 369 - /** 370 - * iucv_message_reply 371 - * @path: address of iucv path structure 372 - * @msg: address of iucv msg structure 373 - * @flags: how the reply is sent (IUCV_IPRMDATA, IUCV_IPPRTY, IUCV_IPBUFLST) 374 - * @reply: address of data buffer or address of struct iucv_array 375 - * @size: length of reply data buffer 376 - * 377 - * This function responds to the two-way messages that you receive. You 378 - * must identify completely the message to which you wish to reply. ie, 379 - * pathid, msgid, and trgcls. Prmmsg signifies the data is moved into 380 - * the parameter list. 381 - * 382 - * Returns: the result from the CP IUCV call. 383 - */ 384 276 int iucv_message_reply(struct iucv_path *path, struct iucv_message *msg, 385 277 u8 flags, void *reply, size_t size); 386 278 387 - /** 388 - * iucv_message_send 389 - * @path: address of iucv path structure 390 - * @msg: address of iucv msg structure 391 - * @flags: how the message is sent (IUCV_IPRMDATA, IUCV_IPPRTY, IUCV_IPBUFLST) 392 - * @srccls: source class of message 393 - * @buffer: address of data buffer or address of struct iucv_array 394 - * @size: length of send buffer 395 - * 396 - * This function transmits data to another application. Data to be 397 - * transmitted is in a buffer and this is a one-way message and the 398 - * receiver will not reply to the message. 399 - * 400 - * Locking: local_bh_enable/local_bh_disable 401 - * 402 - * Returns: the result from the CP IUCV call. 403 - */ 404 279 int iucv_message_send(struct iucv_path *path, struct iucv_message *msg, 405 280 u8 flags, u32 srccls, void *buffer, size_t size); 406 281 407 - /** 408 - * __iucv_message_send 409 - * @path: address of iucv path structure 410 - * @msg: address of iucv msg structure 411 - * @flags: how the message is sent (IUCV_IPRMDATA, IUCV_IPPRTY, IUCV_IPBUFLST) 412 - * @srccls: source class of message 413 - * @buffer: address of data buffer or address of struct iucv_array 414 - * @size: length of send buffer 415 - * 416 - * This function transmits data to another application. Data to be 417 - * transmitted is in a buffer and this is a one-way message and the 418 - * receiver will not reply to the message. 419 - * 420 - * Locking: no locking. 421 - * 422 - * Returns: the result from the CP IUCV call. 423 - */ 424 282 int __iucv_message_send(struct iucv_path *path, struct iucv_message *msg, 425 283 u8 flags, u32 srccls, void *buffer, size_t size); 426 284 427 - /** 428 - * iucv_message_send2way 429 - * @path: address of iucv path structure 430 - * @msg: address of iucv msg structure 431 - * @flags: how the message is sent and the reply is received 432 - * (IUCV_IPRMDATA, IUCV_IPBUFLST, IUCV_IPPRTY, IUCV_ANSLST) 433 - * @srccls: source class of message 434 - * @buffer: address of data buffer or address of struct iucv_array 435 - * @size: length of send buffer 436 - * @ansbuf: address of answer buffer or address of struct iucv_array 437 - * @asize: size of reply buffer 438 - * 439 - * This function transmits data to another application. Data to be 440 - * transmitted is in a buffer. The receiver of the send is expected to 441 - * reply to the message and a buffer is provided into which IUCV moves 442 - * the reply to this message. 443 - * 444 - * Returns: the result from the CP IUCV call. 445 - */ 446 285 int iucv_message_send2way(struct iucv_path *path, struct iucv_message *msg, 447 286 u8 flags, u32 srccls, void *buffer, size_t size, 448 287 void *answer, size_t asize, size_t *residual);

+108 -119

net/iucv/iucv.c

··· 313 313 static union iucv_param *iucv_param_irq[NR_CPUS]; 314 314 315 315 /** 316 - * __iucv_call_b2f0 316 + * __iucv_call_b2f0 - Calls CP to execute IUCV commands. 317 + * 317 318 * @command: identifier of IUCV call to CP. 318 319 * @parm: pointer to a struct iucv_parm block 319 320 * 320 - * Calls CP to execute IUCV commands. 321 - * 322 - * Returns the result of the CP IUCV call. 321 + * Returns: the result of the CP IUCV call. 323 322 */ 324 323 static inline int __iucv_call_b2f0(int command, union iucv_param *parm) 325 324 { ··· 347 348 } 348 349 349 350 /* 350 - * iucv_query_maxconn 351 + * iucv_query_maxconn - Determine the maximum number of connections that 352 + * may be established. 351 353 * 352 - * Determines the maximum number of connections that may be established. 353 - * 354 - * Returns the maximum number of connections or -EPERM is IUCV is not 354 + * Returns: the maximum number of connections or -EPERM is IUCV is not 355 355 * available. 356 356 */ 357 357 static int __iucv_query_maxconn(void *param, unsigned long *max_pathid) ··· 389 391 } 390 392 391 393 /** 392 - * iucv_allow_cpu 393 - * @data: unused 394 + * iucv_allow_cpu - Allow iucv interrupts on this cpu. 394 395 * 395 - * Allow iucv interrupts on this cpu. 396 + * @data: unused 396 397 */ 397 398 static void iucv_allow_cpu(void *data) 398 399 { ··· 429 432 } 430 433 431 434 /** 432 - * iucv_block_cpu 433 - * @data: unused 435 + * iucv_block_cpu - Block iucv interrupts on this cpu. 434 436 * 435 - * Block iucv interrupts on this cpu. 437 + * @data: unused 436 438 */ 437 439 static void iucv_block_cpu(void *data) 438 440 { ··· 448 452 } 449 453 450 454 /** 451 - * iucv_declare_cpu 452 - * @data: unused 455 + * iucv_declare_cpu - Declare a interrupt buffer on this cpu. 453 456 * 454 - * Declare a interrupt buffer on this cpu. 457 + * @data: unused 455 458 */ 456 459 static void iucv_declare_cpu(void *data) 457 460 { ··· 502 507 } 503 508 504 509 /** 505 - * iucv_retrieve_cpu 506 - * @data: unused 510 + * iucv_retrieve_cpu - Retrieve interrupt buffer on this cpu. 507 511 * 508 - * Retrieve interrupt buffer on this cpu. 512 + * @data: unused 509 513 */ 510 514 static void iucv_retrieve_cpu(void *data) 511 515 { ··· 526 532 } 527 533 528 534 /* 529 - * iucv_setmask_mp 530 - * 531 - * Allow iucv interrupts on all cpus. 535 + * iucv_setmask_mp - Allow iucv interrupts on all cpus. 532 536 */ 533 537 static void iucv_setmask_mp(void) 534 538 { ··· 543 551 } 544 552 545 553 /* 546 - * iucv_setmask_up 547 - * 548 - * Allow iucv interrupts on a single cpu. 554 + * iucv_setmask_up - Allow iucv interrupts on a single cpu. 549 555 */ 550 556 static void iucv_setmask_up(void) 551 557 { ··· 558 568 } 559 569 560 570 /* 561 - * iucv_enable 571 + * iucv_enable - Make the iucv ready for use 562 572 * 563 - * This function makes iucv ready for use. It allocates the pathid 564 - * table, declares an iucv interrupt buffer and enables the iucv 565 - * interrupts. Called when the first user has registered an iucv 566 - * handler. 573 + * It allocates the pathid table, declares an iucv interrupt buffer and 574 + * enables the iucv interrupts. Called when the first user has registered 575 + * an iucv handler. 567 576 */ 568 577 static int iucv_enable(void) 569 578 { ··· 592 603 } 593 604 594 605 /* 595 - * iucv_disable 606 + * iucv_disable - Shuts down iucv. 596 607 * 597 - * This function shuts down iucv. It disables iucv interrupts, retrieves 598 - * the iucv interrupt buffer and frees the pathid table. Called after the 599 - * last user unregister its iucv handler. 608 + * It disables iucv interrupts, retrieves the iucv interrupt buffer and frees 609 + * the pathid table. Called after the last user unregister its iucv handler. 600 610 */ 601 611 static void iucv_disable(void) 602 612 { ··· 683 695 } 684 696 685 697 /** 686 - * iucv_sever_pathid 698 + * iucv_sever_pathid - Sever an iucv path to free up the pathid. Used internally. 699 + * 687 700 * @pathid: path identification number. 688 701 * @userdata: 16-bytes of user data. 689 - * 690 - * Sever an iucv path to free up the pathid. Used internally. 691 702 */ 692 703 static int iucv_sever_pathid(u16 pathid, u8 *userdata) 693 704 { ··· 701 714 } 702 715 703 716 /** 704 - * __iucv_cleanup_queue 705 - * @dummy: unused dummy argument 717 + * __iucv_cleanup_queue - Nop function called via smp_call_function to force 718 + * work items from pending external iucv interrupts to the work queue. 706 719 * 707 - * Nop function called via smp_call_function to force work items from 708 - * pending external iucv interrupts to the work queue. 720 + * @dummy: unused dummy argument 709 721 */ 710 722 static void __iucv_cleanup_queue(void *dummy) 711 723 { 712 724 } 713 725 714 726 /** 715 - * iucv_cleanup_queue 727 + * iucv_cleanup_queue - Called after a path has been severed to find all 728 + * remaining work items for the now stale pathid. 716 729 * 717 - * Function called after a path has been severed to find all remaining 718 - * work items for the now stale pathid. The caller needs to hold the 719 - * iucv_table_lock. 730 + * The caller needs to hold the iucv_table_lock. 720 731 */ 721 732 static void iucv_cleanup_queue(void) 722 733 { ··· 742 757 } 743 758 744 759 /** 745 - * iucv_register: 760 + * iucv_register - Registers a driver with IUCV. 761 + * 746 762 * @handler: address of iucv handler structure 747 763 * @smp: != 0 indicates that the handler can deal with out of order messages 748 764 * 749 - * Registers a driver with IUCV. 750 - * 751 - * Returns 0 on success, -ENOMEM if the memory allocation for the pathid 765 + * Returns: 0 on success, -ENOMEM if the memory allocation for the pathid 752 766 * table failed, or -EIO if IUCV_DECLARE_BUFFER failed on all cpus. 753 767 */ 754 768 int iucv_register(struct iucv_handler *handler, int smp) ··· 778 794 EXPORT_SYMBOL(iucv_register); 779 795 780 796 /** 781 - * iucv_unregister 797 + * iucv_unregister - Unregister driver from IUCV. 798 + * 782 799 * @handler: address of iucv handler structure 783 800 * @smp: != 0 indicates that the handler can deal with out of order messages 784 - * 785 - * Unregister driver from IUCV. 786 801 */ 787 802 void iucv_unregister(struct iucv_handler *handler, int smp) 788 803 { ··· 835 852 }; 836 853 837 854 /** 838 - * iucv_path_accept 855 + * iucv_path_accept - Complete the IUCV communication path 856 + * 839 857 * @path: address of iucv path structure 840 858 * @handler: address of iucv handler structure 841 859 * @userdata: 16 bytes of data reflected to the communication partner ··· 845 861 * This function is issued after the user received a connection pending 846 862 * external interrupt and now wishes to complete the IUCV communication path. 847 863 * 848 - * Returns the result of the CP IUCV call. 864 + * Returns: the result of the CP IUCV call. 849 865 */ 850 866 int iucv_path_accept(struct iucv_path *path, struct iucv_handler *handler, 851 867 u8 *userdata, void *private) ··· 880 896 EXPORT_SYMBOL(iucv_path_accept); 881 897 882 898 /** 883 - * iucv_path_connect 899 + * iucv_path_connect - Establish an IUCV path 900 + * 884 901 * @path: address of iucv path structure 885 902 * @handler: address of iucv handler structure 886 903 * @userid: 8-byte user identification ··· 893 908 * successfully, you are not able to use the path until you receive an IUCV 894 909 * Connection Complete external interrupt. 895 910 * 896 - * Returns the result of the CP IUCV call. 911 + * Returns: the result of the CP IUCV call. 897 912 */ 898 913 int iucv_path_connect(struct iucv_path *path, struct iucv_handler *handler, 899 914 u8 *userid, u8 *system, u8 *userdata, ··· 949 964 EXPORT_SYMBOL(iucv_path_connect); 950 965 951 966 /** 952 - * iucv_path_quiesce: 967 + * iucv_path_quiesce - Temporarily suspend incoming messages 953 968 * @path: address of iucv path structure 954 969 * @userdata: 16 bytes of data reflected to the communication partner 955 970 * 956 971 * This function temporarily suspends incoming messages on an IUCV path. 957 972 * You can later reactivate the path by invoking the iucv_resume function. 958 973 * 959 - * Returns the result from the CP IUCV call. 974 + * Returns: the result from the CP IUCV call. 960 975 */ 961 976 int iucv_path_quiesce(struct iucv_path *path, u8 *userdata) 962 977 { ··· 981 996 EXPORT_SYMBOL(iucv_path_quiesce); 982 997 983 998 /** 984 - * iucv_path_resume: 999 + * iucv_path_resume - Resume incoming messages on a suspended IUCV path 1000 + * 985 1001 * @path: address of iucv path structure 986 1002 * @userdata: 16 bytes of data reflected to the communication partner 987 1003 * 988 1004 * This function resumes incoming messages on an IUCV path that has 989 1005 * been stopped with iucv_path_quiesce. 990 1006 * 991 - * Returns the result from the CP IUCV call. 1007 + * Returns: the result from the CP IUCV call. 992 1008 */ 993 1009 int iucv_path_resume(struct iucv_path *path, u8 *userdata) 994 1010 { ··· 1013 1027 } 1014 1028 1015 1029 /** 1016 - * iucv_path_sever 1030 + * iucv_path_sever - Terminates an IUCV path. 1031 + * 1017 1032 * @path: address of iucv path structure 1018 1033 * @userdata: 16 bytes of data reflected to the communication partner 1019 1034 * 1020 - * This function terminates an IUCV path. 1021 - * 1022 - * Returns the result from the CP IUCV call. 1035 + * Returns: the result from the CP IUCV call. 1023 1036 */ 1024 1037 int iucv_path_sever(struct iucv_path *path, u8 *userdata) 1025 1038 { ··· 1043 1058 EXPORT_SYMBOL(iucv_path_sever); 1044 1059 1045 1060 /** 1046 - * iucv_message_purge 1061 + * iucv_message_purge - Cancels a message you have sent. 1062 + * 1047 1063 * @path: address of iucv path structure 1048 1064 * @msg: address of iucv msg structure 1049 1065 * @srccls: source class of message 1050 1066 * 1051 - * Cancels a message you have sent. 1052 - * 1053 - * Returns the result from the CP IUCV call. 1067 + * Returns: the result from the CP IUCV call. 1054 1068 */ 1055 1069 int iucv_message_purge(struct iucv_path *path, struct iucv_message *msg, 1056 1070 u32 srccls) ··· 1080 1096 EXPORT_SYMBOL(iucv_message_purge); 1081 1097 1082 1098 /** 1083 - * iucv_message_receive_iprmdata 1099 + * iucv_message_receive_iprmdata - Internal function to receive RMDATA 1100 + * stored in &struct iucv_message 1101 + * 1084 1102 * @path: address of iucv path structure 1085 1103 * @msg: address of iucv msg structure 1086 1104 * @flags: how the message is received (IUCV_IPBUFLST) 1087 1105 * @buffer: address of data buffer or address of struct iucv_array 1088 1106 * @size: length of data buffer 1089 - * @residual: 1107 + * @residual: number of bytes remaining in the data buffer 1090 1108 * 1091 1109 * Internal function used by iucv_message_receive and __iucv_message_receive 1092 1110 * to receive RMDATA data stored in struct iucv_message. ··· 1126 1140 } 1127 1141 1128 1142 /** 1129 - * __iucv_message_receive 1143 + * __iucv_message_receive - Receives messages on an established path (no locking) 1144 + * 1130 1145 * @path: address of iucv path structure 1131 1146 * @msg: address of iucv msg structure 1132 - * @flags: how the message is received (IUCV_IPBUFLST) 1147 + * @flags: flags that affect how the message is received (IUCV_IPBUFLST) 1133 1148 * @buffer: address of data buffer or address of struct iucv_array 1134 1149 * @size: length of data buffer 1135 1150 * @residual: ··· 1141 1154 * 1142 1155 * Locking: no locking 1143 1156 * 1144 - * Returns the result from the CP IUCV call. 1157 + * Returns: the result from the CP IUCV call. 1145 1158 */ 1146 1159 int __iucv_message_receive(struct iucv_path *path, struct iucv_message *msg, 1147 1160 u8 flags, void *buffer, size_t size, size_t *residual) ··· 1175 1188 EXPORT_SYMBOL(__iucv_message_receive); 1176 1189 1177 1190 /** 1178 - * iucv_message_receive 1191 + * iucv_message_receive - Receives messages on an established path, with locking 1192 + * 1179 1193 * @path: address of iucv path structure 1180 1194 * @msg: address of iucv msg structure 1181 - * @flags: how the message is received (IUCV_IPBUFLST) 1195 + * @flags: flags that affect how the message is received (IUCV_IPBUFLST) 1182 1196 * @buffer: address of data buffer or address of struct iucv_array 1183 1197 * @size: length of data buffer 1184 1198 * @residual: ··· 1190 1202 * 1191 1203 * Locking: local_bh_enable/local_bh_disable 1192 1204 * 1193 - * Returns the result from the CP IUCV call. 1205 + * Returns: the result from the CP IUCV call. 1194 1206 */ 1195 1207 int iucv_message_receive(struct iucv_path *path, struct iucv_message *msg, 1196 1208 u8 flags, void *buffer, size_t size, size_t *residual) ··· 1208 1220 EXPORT_SYMBOL(iucv_message_receive); 1209 1221 1210 1222 /** 1211 - * iucv_message_reject 1223 + * iucv_message_reject - Refuses a specified message 1224 + * 1212 1225 * @path: address of iucv path structure 1213 1226 * @msg: address of iucv msg structure 1214 1227 * ··· 1217 1228 * are notified of a message and the time that you complete the message, 1218 1229 * the message may be rejected. 1219 1230 * 1220 - * Returns the result from the CP IUCV call. 1231 + * Returns: the result from the CP IUCV call. 1221 1232 */ 1222 1233 int iucv_message_reject(struct iucv_path *path, struct iucv_message *msg) 1223 1234 { ··· 1243 1254 EXPORT_SYMBOL(iucv_message_reject); 1244 1255 1245 1256 /** 1246 - * iucv_message_reply 1257 + * iucv_message_reply - Replies to a specified message 1258 + * 1247 1259 * @path: address of iucv path structure 1248 1260 * @msg: address of iucv msg structure 1249 1261 * @flags: how the reply is sent (IUCV_IPRMDATA, IUCV_IPPRTY, IUCV_IPBUFLST) ··· 1252 1262 * @size: length of reply data buffer 1253 1263 * 1254 1264 * This function responds to the two-way messages that you receive. You 1255 - * must identify completely the message to which you wish to reply. ie, 1265 + * must identify completely the message to which you wish to reply. I.e., 1256 1266 * pathid, msgid, and trgcls. Prmmsg signifies the data is moved into 1257 1267 * the parameter list. 1258 1268 * 1259 - * Returns the result from the CP IUCV call. 1269 + * Returns: the result from the CP IUCV call. 1260 1270 */ 1261 1271 int iucv_message_reply(struct iucv_path *path, struct iucv_message *msg, 1262 1272 u8 flags, void *reply, size_t size) ··· 1293 1303 EXPORT_SYMBOL(iucv_message_reply); 1294 1304 1295 1305 /** 1296 - * __iucv_message_send 1306 + * __iucv_message_send - Transmits a one-way message, no locking 1307 + * 1297 1308 * @path: address of iucv path structure 1298 1309 * @msg: address of iucv msg structure 1299 1310 * @flags: how the message is sent (IUCV_IPRMDATA, IUCV_IPPRTY, IUCV_IPBUFLST) ··· 1308 1317 * 1309 1318 * Locking: no locking 1310 1319 * 1311 - * Returns the result from the CP IUCV call. 1320 + * Returns: the result from the CP IUCV call. 1312 1321 */ 1313 1322 int __iucv_message_send(struct iucv_path *path, struct iucv_message *msg, 1314 1323 u8 flags, u32 srccls, void *buffer, size_t size) ··· 1348 1357 EXPORT_SYMBOL(__iucv_message_send); 1349 1358 1350 1359 /** 1351 - * iucv_message_send 1360 + * iucv_message_send - Transmits a one-way message, with locking 1361 + * 1352 1362 * @path: address of iucv path structure 1353 1363 * @msg: address of iucv msg structure 1354 1364 * @flags: how the message is sent (IUCV_IPRMDATA, IUCV_IPPRTY, IUCV_IPBUFLST) ··· 1363 1371 * 1364 1372 * Locking: local_bh_enable/local_bh_disable 1365 1373 * 1366 - * Returns the result from the CP IUCV call. 1374 + * Returns: the result from the CP IUCV call. 1367 1375 */ 1368 1376 int iucv_message_send(struct iucv_path *path, struct iucv_message *msg, 1369 1377 u8 flags, u32 srccls, void *buffer, size_t size) ··· 1378 1386 EXPORT_SYMBOL(iucv_message_send); 1379 1387 1380 1388 /** 1381 - * iucv_message_send2way 1389 + * iucv_message_send2way - Transmits a two-way message 1390 + * 1382 1391 * @path: address of iucv path structure 1383 1392 * @msg: address of iucv msg structure 1384 1393 * @flags: how the message is sent and the reply is received ··· 1396 1403 * reply to the message and a buffer is provided into which IUCV moves 1397 1404 * the reply to this message. 1398 1405 * 1399 - * Returns the result from the CP IUCV call. 1406 + * Returns: the result from the CP IUCV call. 1400 1407 */ 1401 1408 int iucv_message_send2way(struct iucv_path *path, struct iucv_message *msg, 1402 1409 u8 flags, u32 srccls, void *buffer, size_t size, ··· 1455 1462 } __packed; 1456 1463 1457 1464 /** 1458 - * iucv_path_pending 1465 + * iucv_path_pending - Process connection pending work item 1466 + * 1459 1467 * @data: Pointer to external interrupt buffer 1460 1468 * 1461 - * Process connection pending work item. Called from tasklet while holding 1462 - * iucv_table_lock. 1469 + * Context: Called from tasklet while holding iucv_table_lock. 1463 1470 */ 1464 1471 static void iucv_path_pending(struct iucv_irq_data *data) 1465 1472 { ··· 1516 1523 } __packed; 1517 1524 1518 1525 /** 1519 - * iucv_path_complete 1526 + * iucv_path_complete - Process connection complete work item 1527 + * 1520 1528 * @data: Pointer to external interrupt buffer 1521 1529 * 1522 - * Process connection complete work item. Called from tasklet while holding 1523 - * iucv_table_lock. 1530 + * Context: Called from tasklet while holding iucv_table_lock. 1524 1531 */ 1525 1532 static void iucv_path_complete(struct iucv_irq_data *data) 1526 1533 { ··· 1546 1553 } __packed; 1547 1554 1548 1555 /** 1549 - * iucv_path_severed 1556 + * iucv_path_severed - Process connection severed work item. 1557 + * 1550 1558 * @data: Pointer to external interrupt buffer 1551 1559 * 1552 - * Process connection severed work item. Called from tasklet while holding 1553 - * iucv_table_lock. 1560 + * Context: Called from tasklet while holding iucv_table_lock. 1554 1561 */ 1555 1562 static void iucv_path_severed(struct iucv_irq_data *data) 1556 1563 { ··· 1582 1589 } __packed; 1583 1590 1584 1591 /** 1585 - * iucv_path_quiesced 1592 + * iucv_path_quiesced - Process connection quiesced work item. 1593 + * 1586 1594 * @data: Pointer to external interrupt buffer 1587 1595 * 1588 - * Process connection quiesced work item. Called from tasklet while holding 1589 - * iucv_table_lock. 1596 + * Context: Called from tasklet while holding iucv_table_lock. 1590 1597 */ 1591 1598 static void iucv_path_quiesced(struct iucv_irq_data *data) 1592 1599 { ··· 1610 1617 } __packed; 1611 1618 1612 1619 /** 1613 - * iucv_path_resumed 1620 + * iucv_path_resumed - Process connection resumed work item. 1621 + * 1614 1622 * @data: Pointer to external interrupt buffer 1615 1623 * 1616 - * Process connection resumed work item. Called from tasklet while holding 1617 - * iucv_table_lock. 1624 + * Context: Called from tasklet while holding iucv_table_lock. 1618 1625 */ 1619 1626 static void iucv_path_resumed(struct iucv_irq_data *data) 1620 1627 { ··· 1641 1648 } __packed; 1642 1649 1643 1650 /** 1644 - * iucv_message_complete 1651 + * iucv_message_complete - Process message complete work item. 1652 + * 1645 1653 * @data: Pointer to external interrupt buffer 1646 1654 * 1647 - * Process message complete work item. Called from tasklet while holding 1648 - * iucv_table_lock. 1655 + * Context: Called from tasklet while holding iucv_table_lock. 1649 1656 */ 1650 1657 static void iucv_message_complete(struct iucv_irq_data *data) 1651 1658 { ··· 1688 1695 } __packed; 1689 1696 1690 1697 /** 1691 - * iucv_message_pending 1698 + * iucv_message_pending - Process message pending work item. 1699 + * 1692 1700 * @data: Pointer to external interrupt buffer 1693 1701 * 1694 - * Process message pending work item. Called from tasklet while holding 1695 - * iucv_table_lock. 1702 + * Context: Called from tasklet while holding iucv_table_lock. 1696 1703 */ 1697 1704 static void iucv_message_pending(struct iucv_irq_data *data) 1698 1705 { ··· 1715 1722 } 1716 1723 1717 1724 /* 1718 - * iucv_tasklet_fn: 1725 + * iucv_tasklet_fn - Process the queue of IRQ buffers 1719 1726 * 1720 1727 * This tasklet loops over the queue of irq buffers created by 1721 1728 * iucv_external_interrupt, calls the appropriate action handler ··· 1759 1766 } 1760 1767 1761 1768 /* 1762 - * iucv_work_fn: 1769 + * iucv_work_fn - Process the queue of path pending IRQ blocks 1763 1770 * 1764 1771 * This work function loops over the queue of path pending irq blocks 1765 1772 * created by iucv_external_interrupt, calls the appropriate action ··· 1790 1797 } 1791 1798 1792 1799 /* 1793 - * iucv_external_interrupt 1800 + * iucv_external_interrupt - Handles external interrupts coming in from CP. 1794 1801 * 1795 - * Handles external interrupts coming in from CP. 1796 1802 * Places the interrupt buffer on a queue and schedules iucv_tasklet_fn(). 1797 1803 */ 1798 1804 static void iucv_external_interrupt(struct ext_code ext_code, ··· 1849 1857 EXPORT_SYMBOL(iucv_if); 1850 1858 1851 1859 static enum cpuhp_state iucv_online; 1860 + 1852 1861 /** 1853 - * iucv_init 1854 - * 1855 - * Allocates and initializes various data structures. 1862 + * iucv_init - Allocates and initializes various data structures. 1856 1863 */ 1857 1864 static int __init iucv_init(void) 1858 1865 { ··· 1915 1924 } 1916 1925 1917 1926 /** 1918 - * iucv_exit 1919 - * 1920 - * Frees everything allocated from iucv_init. 1927 + * iucv_exit - Frees everything allocated from iucv_init. 1921 1928 */ 1922 1929 static void __exit iucv_exit(void) 1923 1930 {

Configure Feed

Configure Feed