tree: https://git.kernel.org/pub/scm/linux/kernel/git/herbert/cryptodev-2.6.git master head: f0e2ce58f853634d7ad1a418a49bd5fbd556227c commit: 560b1a82ee87288c18aca31ee3053272c3737fe5 [21/61] crypto: doc - clarify return values for async hash methods reproduce: make htmldocs
All warnings (new ones prefixed by >>): WARNING: convert(1) not found, for SVG to PDF conversion install ImageMagick (https://www.imagemagick.org) kernel/trace/blktrace.c:818: warning: No description found for parameter 'cgid' >> include/crypto/hash.h:89: warning: duplicate section name 'Note' include/crypto/hash.h:95: warning: duplicate section name 'Note' include/crypto/hash.h:102: warning: duplicate section name 'Note' >> include/crypto/hash.h:89: warning: duplicate section name 'Note' include/crypto/hash.h:95: warning: duplicate section name 'Note' include/crypto/hash.h:102: warning: duplicate section name 'Note' >> include/crypto/hash.h:89: warning: duplicate section name 'Note' include/crypto/hash.h:95: warning: duplicate section name 'Note' include/crypto/hash.h:102: warning: duplicate section name 'Note' >> include/crypto/hash.h:89: warning: duplicate section name 'Note' include/crypto/hash.h:95: warning: duplicate section name 'Note' include/crypto/hash.h:102: warning: duplicate section name 'Note' >> include/crypto/hash.h:89: warning: duplicate section name 'Note' include/crypto/hash.h:95: warning: duplicate section name 'Note' include/crypto/hash.h:102: warning: duplicate section name 'Note' >> include/crypto/hash.h:89: warning: duplicate section name 'Note' include/crypto/hash.h:95: warning: duplicate section name 'Note' include/crypto/hash.h:102: warning: duplicate section name 'Note' >> include/crypto/hash.h:89: warning: duplicate section name 'Note' include/crypto/hash.h:95: warning: duplicate section name 'Note' include/crypto/hash.h:102: warning: duplicate section name 'Note' >> include/crypto/hash.h:89: warning: duplicate section name 'Note' include/crypto/hash.h:95: warning: duplicate section name 'Note' include/crypto/hash.h:102: warning: duplicate section name 'Note' include/linux/sync_file.h:51: warning: No description found for parameter 'flags' drivers/gpio/gpiolib.c:593: warning: No description found for parameter '16' drivers/gpio/gpiolib.c:593: warning: Excess struct/union/enum/typedef member 'events' description in 'lineevent_state' include/linux/usb/gadget.h:232: warning: No description found for parameter 'claimed' include/linux/usb/gadget.h:232: warning: No description found for parameter 'enabled' include/linux/usb/gadget.h:414: warning: No description found for parameter 'quirk_altset_not_supp' include/linux/usb/gadget.h:414: warning: No description found for parameter 'quirk_stall_not_supp' include/linux/usb/gadget.h:414: warning: No description found for parameter 'quirk_zlp_not_supp' fs/inode.c:1680: warning: No description found for parameter 'rcu' include/linux/jbd2.h:443: warning: No description found for parameter 'i_transaction' include/linux/jbd2.h:443: warning: No description found for parameter 'i_next_transaction' include/linux/jbd2.h:443: warning: No description found for parameter 'i_list' include/linux/jbd2.h:443: warning: No description found for parameter 'i_vfs_inode' include/linux/jbd2.h:443: warning: No description found for parameter 'i_flags' include/linux/jbd2.h:497: warning: No description found for parameter 'h_rsv_handle' include/linux/jbd2.h:497: warning: No description found for parameter 'h_reserved' include/linux/jbd2.h:497: warning: No description found for parameter 'h_type' include/linux/jbd2.h:497: warning: No description found for parameter 'h_line_no' include/linux/jbd2.h:497: warning: No description found for parameter 'h_start_jiffies' include/linux/jbd2.h:497: warning: No description found for parameter 'h_requested_credits' include/linux/jbd2.h:497: warning: No description found for parameter 'saved_alloc_context' include/linux/jbd2.h:1050: warning: No description found for parameter 'j_chkpt_bhs' include/linux/jbd2.h:1050: warning: No description found for parameter 'j_devname' include/linux/jbd2.h:1050: warning: No description found for parameter 'j_average_commit_time' include/linux/jbd2.h:1050: warning: No description found for parameter 'j_min_batch_time' include/linux/jbd2.h:1050: warning: No description found for parameter 'j_max_batch_time' include/linux/jbd2.h:1050: warning: No description found for parameter 'j_commit_callback' include/linux/jbd2.h:1050: warning: No description found for parameter 'j_failed_commit' include/linux/jbd2.h:1050: warning: No description found for parameter 'j_chksum_driver' include/linux/jbd2.h:1050: warning: No description found for parameter 'j_csum_seed' fs/jbd2/transaction.c:511: warning: No description found for parameter 'type' fs/jbd2/transaction.c:511: warning: No description found for parameter 'line_no' fs/jbd2/transaction.c:641: warning: No description found for parameter 'gfp_mask' include/drm/drm_drv.h:594: warning: No description found for parameter 'gem_prime_pin' include/drm/drm_drv.h:594: warning: No description found for parameter 'gem_prime_unpin' include/drm/drm_drv.h:594: warning: No description found for parameter 'gem_prime_res_obj' include/drm/drm_drv.h:594: warning: No description found for parameter 'gem_prime_get_sg_table' include/drm/drm_drv.h:594: warning: No description found for parameter 'gem_prime_import_sg_table' include/drm/drm_drv.h:594: warning: No description found for parameter 'gem_prime_vmap' include/drm/drm_drv.h:594: warning: No description found for parameter 'gem_prime_vunmap' include/drm/drm_drv.h:594: warning: No description found for parameter 'gem_prime_mmap' include/drm/drm_mode_config.h:771: warning: No description found for parameter 'modifiers_property' include/drm/drm_mode_config.h:771: warning: Excess struct/union/enum/typedef member 'modifiers' description in 'drm_mode_config' include/drm/drm_plane.h:544: warning: No description found for parameter 'modifiers' include/drm/drm_plane.h:544: warning: No description found for parameter 'modifier_count' drivers/gpu/host1x/bus.c:50: warning: No description found for parameter 'driver' Documentation/core-api/kernel-api.rst:354: ERROR: Error in "kernel-doc" directive: unknown option: "external". vim +/Note +89 include/crypto/hash.h 88056ec34 Herbert Xu 2009-07-14 66 d4421c54c Herbert Xu 2015-08-20 67 #define AHASH_REQUEST_ON_STACK(name, ahash) \ d4421c54c Herbert Xu 2015-08-20 68 char __##name##_desc[sizeof(struct ahash_request) + \ d4421c54c Herbert Xu 2015-08-20 69 crypto_ahash_reqsize(ahash)] CRYPTO_MINALIGN_ATTR; \ d4421c54c Herbert Xu 2015-08-20 70 struct ahash_request *name = (void *)__##name##_desc d4421c54c Herbert Xu 2015-08-20 71 5d8c723f6 Stephan Mueller 2014-11-12 72 /** 5d8c723f6 Stephan Mueller 2014-11-12 73 * struct ahash_alg - asynchronous message digest definition 5d8c723f6 Stephan Mueller 2014-11-12 74 * @init: Initialize the transformation context. Intended only to initialize the 12f7c14aa Masanari Iida 2015-06-04 75 * state of the HASH transformation at the beginning. This shall fill in 5d8c723f6 Stephan Mueller 2014-11-12 76 * the internal structures used during the entire duration of the whole 5d8c723f6 Stephan Mueller 2014-11-12 77 * transformation. No data processing happens at this point. 560b1a82e Kamil Konieczny 2017-08-17 78 * Note: mandatory. 5d8c723f6 Stephan Mueller 2014-11-12 79 * @update: Push a chunk of data into the driver for transformation. This 5d8c723f6 Stephan Mueller 2014-11-12 80 * function actually pushes blocks of data from upper layers into the 5d8c723f6 Stephan Mueller 2014-11-12 81 * driver, which then passes those to the hardware as seen fit. This 5d8c723f6 Stephan Mueller 2014-11-12 82 * function must not finalize the HASH transformation by calculating the 5d8c723f6 Stephan Mueller 2014-11-12 83 * final message digest as this only adds more data into the 5d8c723f6 Stephan Mueller 2014-11-12 84 * transformation. This function shall not modify the transformation 5d8c723f6 Stephan Mueller 2014-11-12 85 * context, as this function may be called in parallel with the same 5d8c723f6 Stephan Mueller 2014-11-12 86 * transformation object. Data processing can happen synchronously 5d8c723f6 Stephan Mueller 2014-11-12 87 * [SHASH] or asynchronously [AHASH] at this point. 560b1a82e Kamil Konieczny 2017-08-17 88 * Note: mandatory. 5d8c723f6 Stephan Mueller 2014-11-12 @89 * @final: Retrieve result from the driver. This function finalizes the 5d8c723f6 Stephan Mueller 2014-11-12 90 * transformation and retrieves the resulting hash from the driver and 5d8c723f6 Stephan Mueller 2014-11-12 91 * pushes it back to upper layers. No data processing happens at this 560b1a82e Kamil Konieczny 2017-08-17 92 * point unless hardware requires it to finish the transformation 560b1a82e Kamil Konieczny 2017-08-17 93 * (then the data buffered by the device driver is processed). 560b1a82e Kamil Konieczny 2017-08-17 94 * Note: mandatory. 5d8c723f6 Stephan Mueller 2014-11-12 95 * @finup: Combination of @update and @final. This function is effectively a 5d8c723f6 Stephan Mueller 2014-11-12 96 * combination of @update and @final calls issued in sequence. As some 5d8c723f6 Stephan Mueller 2014-11-12 97 * hardware cannot do @update and @final separately, this callback was 5d8c723f6 Stephan Mueller 2014-11-12 98 * added to allow such hardware to be used at least by IPsec. Data 5d8c723f6 Stephan Mueller 2014-11-12 99 * processing can happen synchronously [SHASH] or asynchronously [AHASH] 5d8c723f6 Stephan Mueller 2014-11-12 100 * at this point. 560b1a82e Kamil Konieczny 2017-08-17 101 * Note: optional. 5d8c723f6 Stephan Mueller 2014-11-12 102 * @digest: Combination of @init and @update and @final. This function 5d8c723f6 Stephan Mueller 2014-11-12 103 * effectively behaves as the entire chain of operations, @init, 5d8c723f6 Stephan Mueller 2014-11-12 104 * @update and @final issued in sequence. Just like @finup, this was 5d8c723f6 Stephan Mueller 2014-11-12 105 * added for hardware which cannot do even the @finup, but can only do 5d8c723f6 Stephan Mueller 2014-11-12 106 * the whole transformation in one run. Data processing can happen 5d8c723f6 Stephan Mueller 2014-11-12 107 * synchronously [SHASH] or asynchronously [AHASH] at this point. 5d8c723f6 Stephan Mueller 2014-11-12 108 * @setkey: Set optional key used by the hashing algorithm. Intended to push 5d8c723f6 Stephan Mueller 2014-11-12 109 * optional key used by the hashing algorithm from upper layers into 5d8c723f6 Stephan Mueller 2014-11-12 110 * the driver. This function can store the key in the transformation 5d8c723f6 Stephan Mueller 2014-11-12 111 * context or can outright program it into the hardware. In the former 5d8c723f6 Stephan Mueller 2014-11-12 112 * case, one must be careful to program the key into the hardware at 5d8c723f6 Stephan Mueller 2014-11-12 113 * appropriate time and one must be careful that .setkey() can be 5d8c723f6 Stephan Mueller 2014-11-12 114 * called multiple times during the existence of the transformation 5d8c723f6 Stephan Mueller 2014-11-12 115 * object. Not all hashing algorithms do implement this function as it 5d8c723f6 Stephan Mueller 2014-11-12 116 * is only needed for keyed message digests. SHAx/MDx/CRCx do NOT 5d8c723f6 Stephan Mueller 2014-11-12 117 * implement this function. HMAC(MDx)/HMAC(SHAx)/CMAC(AES) do implement 5d8c723f6 Stephan Mueller 2014-11-12 118 * this function. This function must be called before any other of the 5d8c723f6 Stephan Mueller 2014-11-12 119 * @init, @update, @final, @finup, @digest is called. No data 5d8c723f6 Stephan Mueller 2014-11-12 120 * processing happens at this point. 5d8c723f6 Stephan Mueller 2014-11-12 121 * @export: Export partial state of the transformation. This function dumps the 5d8c723f6 Stephan Mueller 2014-11-12 122 * entire state of the ongoing transformation into a provided block of 5d8c723f6 Stephan Mueller 2014-11-12 123 * data so it can be @import 'ed back later on. This is useful in case 5d8c723f6 Stephan Mueller 2014-11-12 124 * you want to save partial result of the transformation after 5d8c723f6 Stephan Mueller 2014-11-12 125 * processing certain amount of data and reload this partial result 5d8c723f6 Stephan Mueller 2014-11-12 126 * multiple times later on for multiple re-use. No data processing 5d8c723f6 Stephan Mueller 2014-11-12 127 * happens at this point. 5d8c723f6 Stephan Mueller 2014-11-12 128 * @import: Import partial state of the transformation. This function loads the 5d8c723f6 Stephan Mueller 2014-11-12 129 * entire state of the ongoing transformation from a provided block of 5d8c723f6 Stephan Mueller 2014-11-12 130 * data so the transformation can continue from this point onward. No 5d8c723f6 Stephan Mueller 2014-11-12 131 * data processing happens at this point. 52744af3a Stephan Mueller 2014-11-14 132 * @halg: see struct hash_alg_common 5d8c723f6 Stephan Mueller 2014-11-12 133 */ 88056ec34 Herbert Xu 2009-07-14 134 struct ahash_alg { 88056ec34 Herbert Xu 2009-07-14 135 int (*init)(struct ahash_request *req); 88056ec34 Herbert Xu 2009-07-14 136 int (*update)(struct ahash_request *req); 88056ec34 Herbert Xu 2009-07-14 137 int (*final)(struct ahash_request *req); 88056ec34 Herbert Xu 2009-07-14 138 int (*finup)(struct ahash_request *req); 88056ec34 Herbert Xu 2009-07-14 139 int (*digest)(struct ahash_request *req); 88056ec34 Herbert Xu 2009-07-14 140 int (*export)(struct ahash_request *req, void *out); 88056ec34 Herbert Xu 2009-07-14 141 int (*import)(struct ahash_request *req, const void *in); 88056ec34 Herbert Xu 2009-07-14 142 int (*setkey)(struct crypto_ahash *tfm, const u8 *key, 88056ec34 Herbert Xu 2009-07-14 143 unsigned int keylen); 88056ec34 Herbert Xu 2009-07-14 144 88056ec34 Herbert Xu 2009-07-14 145 struct hash_alg_common halg; 88056ec34 Herbert Xu 2009-07-14 146 }; 88056ec34 Herbert Xu 2009-07-14 147 :::::: The code at line 89 was first introduced by commit :::::: 5d8c723f61f2e6dacbd02d80a516115993c4f292 crypto: doc - hash data structures :::::: TO: Stephan Mueller <smuel...@chronox.de> :::::: CC: Herbert Xu <herb...@gondor.apana.org.au> --- 0-DAY kernel test infrastructure Open Source Technology Center https://lists.01.org/pipermail/kbuild-all Intel Corporation
.config.gz
Description: application/gzip
