Commit e50abbe6 authored by Alexey Marchuk's avatar Alexey Marchuk Committed by Tomasz Zawadzki
Browse files

lib/accel: Deprecate `flags` parameter 



This parameter is not used

Signed-off-by: default avatarAlexey Marchuk <alexeymar@nvidia.com>
Change-Id: Ibd19f97b21d2c678cc7997981112e6cece879ad0
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/21478


Reviewed-by: default avatarBen Walker <ben@nvidia.com>
Reviewed-by: default avatarJim Harris <jim.harris@samsung.com>
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: Mellanox Build Bot
parent 1e826669

deprecation.md

+7 −0
Original line number Diff line number Diff line
@@ -19,6 +19,13 @@ The tags can be matched with the level 4 headers below. 


## Deprecation Notices



### accel



#### `flags` parameter in *submit* and *append* functions



The `int flags` parameter in various *submit* and *append* accel FW API is not used and deprecated. It will be removed

in 24.05 release.



### util



#### `spdk_iov_one`

lib/accel/accel.c

+7 −0
Original line number Diff line number Diff line
@@ -370,6 +370,10 @@ do { \ 
        (task)->has_aux = true;							\

} while (0)



SPDK_LOG_DEPRECATION_REGISTER(accel_flags,

			      "The flags parameter is unused and deprecated",

			      "v24.05", 0);



/* \b `flags` is int in API, since it is not used anywahere. we narrowed it down to uint8_t internally

 * To prevent possible problems in the future, add a macro which checks that the value of `flags` passed in the API

 * doesn't exceed 1 byte. */
@@ -377,6 +381,9 @@ do { \ 
do {											\

	assert(((flags) & (~0xff)) == 0 && "task::flags needs to be extended");		\

	(task)->flags = (uint8_t)(flags);						\

	if ((task)->flags) {								\

		SPDK_LOG_DEPRECATED(accel_flags);					\

	}										\

} while (0)										\



/* Accel framework public API for copy function */