1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright(c) 2017-2018 Intel Corporation 3 */ 4 5 #ifndef _RTE_COMPRESSDEV_PMD_H_ 6 #define _RTE_COMPRESSDEV_PMD_H_ 7 8 /** @file 9 * RTE comp PMD APIs 10 * 11 * @note 12 * These APIs are for comp PMDs only and user applications should not call 13 * them directly. 14 */ 15 16 #ifdef __cplusplus 17 extern "C" { 18 #endif 19 20 #include <string.h> 21 22 #include <dev_driver.h> 23 24 #include "rte_compressdev.h" 25 #include "rte_compressdev_internal.h" 26 27 #define RTE_COMPRESSDEV_PMD_NAME_ARG ("name") 28 #define RTE_COMPRESSDEV_PMD_SOCKET_ID_ARG ("socket_id") 29 30 static const char * const compressdev_pmd_valid_params[] = { 31 RTE_COMPRESSDEV_PMD_NAME_ARG, 32 RTE_COMPRESSDEV_PMD_SOCKET_ID_ARG 33 }; 34 35 /** 36 * @internal 37 * Initialisation parameters for comp devices 38 */ 39 struct rte_compressdev_pmd_init_params { 40 char name[RTE_COMPRESSDEV_NAME_MAX_LEN]; 41 int socket_id; 42 }; 43 44 /** Global structure used for maintaining state of allocated comp devices */ 45 struct rte_compressdev_global { 46 struct rte_compressdev *devs; /**< Device information array */ 47 struct rte_compressdev_data *data[RTE_COMPRESS_MAX_DEVS]; 48 /**< Device private data */ 49 uint8_t nb_devs; /**< Number of devices found */ 50 uint8_t max_devs; /**< Max number of devices */ 51 }; 52 53 /** 54 * Get the rte_compressdev structure device pointer for the named device. 55 * 56 * @param name 57 * Compress device name 58 * @return 59 * - The rte_compressdev structure pointer for the given device identifier. 60 */ 61 __rte_experimental 62 struct rte_compressdev * 63 rte_compressdev_pmd_get_named_dev(const char *name); 64 65 /** 66 * Definitions of all functions exported by a driver through 67 * the generic structure of type *comp_dev_ops* supplied in the 68 * *rte_compressdev* structure associated with a device. 69 */ 70 71 /** 72 * Function used to configure device. 73 * 74 * @param dev 75 * Compress device 76 * @param config 77 * Compress device configurations 78 * @return 79 * Returns 0 on success 80 */ 81 typedef int (*compressdev_configure_t)(struct rte_compressdev *dev, 82 struct rte_compressdev_config *config); 83 84 /** 85 * Function used to start a configured device. 86 * 87 * @param dev 88 * Compress device 89 * @return 90 * Returns 0 on success 91 */ 92 typedef int (*compressdev_start_t)(struct rte_compressdev *dev); 93 94 /** 95 * Function used to stop a configured device. 96 * 97 * @param dev 98 * Compress device 99 */ 100 typedef void (*compressdev_stop_t)(struct rte_compressdev *dev); 101 102 /** 103 * Function used to close a configured device. 104 * 105 * @param dev 106 * Compress device 107 * @return 108 * - 0 on success. 109 * - EAGAIN if can't close as device is busy 110 */ 111 typedef int (*compressdev_close_t)(struct rte_compressdev *dev); 112 113 114 /** 115 * Function used to get statistics of a device. 116 * 117 * @param dev 118 * Compress device 119 * @param stats 120 * Compress device stats to populate 121 */ 122 typedef void (*compressdev_stats_get_t)(struct rte_compressdev *dev, 123 struct rte_compressdev_stats *stats); 124 125 126 /** 127 * Function used to reset statistics of a device. 128 * 129 * @param dev 130 * Compress device 131 */ 132 typedef void (*compressdev_stats_reset_t)(struct rte_compressdev *dev); 133 134 135 /** 136 * Function used to get specific information of a device. 137 * 138 * @param dev 139 * Compress device 140 * @param dev_info 141 * Compress device information to populate 142 */ 143 typedef void (*compressdev_info_get_t)(struct rte_compressdev *dev, 144 struct rte_compressdev_info *dev_info); 145 146 /** 147 * Setup a queue pair for a device. 148 * 149 * @param dev 150 * Compress device 151 * @param qp_id 152 * Queue pair identifier 153 * @param max_inflight_ops 154 * Max inflight ops which qp must accommodate 155 * @param socket_id 156 * Socket identifier 157 * @return 158 * Returns 0 on success. 159 */ 160 typedef int (*compressdev_queue_pair_setup_t)(struct rte_compressdev *dev, 161 uint16_t qp_id, uint32_t max_inflight_ops, int socket_id); 162 163 /** 164 * Release memory resources allocated by given queue pair. 165 * 166 * @param dev 167 * Compress device 168 * @param qp_id 169 * Queue pair identifier 170 * @return 171 * - 0 on success. 172 * - EAGAIN if can't close as device is busy 173 */ 174 typedef int (*compressdev_queue_pair_release_t)(struct rte_compressdev *dev, 175 uint16_t qp_id); 176 177 /** 178 * Create driver private stream data. 179 * 180 * @param dev 181 * Compressdev device 182 * @param xform 183 * xform data 184 * @param stream 185 * ptr where handle of pmd's private stream data should be stored 186 * @return 187 * - Returns 0 if private stream structure has been created successfully. 188 * - Returns -EINVAL if input parameters are invalid. 189 * - Returns -ENOTSUP if comp device does not support STATEFUL operations. 190 * - Returns -ENOTSUP if comp device does not support the comp transform. 191 * - Returns -ENOMEM if the private stream could not be allocated. 192 */ 193 typedef int (*compressdev_stream_create_t)(struct rte_compressdev *dev, 194 const struct rte_comp_xform *xform, void **stream); 195 196 /** 197 * Free driver private stream data. 198 * 199 * @param dev 200 * Compressdev device 201 * @param stream 202 * handle of pmd's private stream data 203 * @return 204 * - 0 if successful 205 * - <0 in error cases 206 * - Returns -EINVAL if input parameters are invalid. 207 * - Returns -ENOTSUP if comp device does not support STATEFUL operations. 208 * - Returns -EBUSY if can't free stream as there are inflight operations 209 */ 210 typedef int (*compressdev_stream_free_t)(struct rte_compressdev *dev, 211 void *stream); 212 213 /** 214 * Create driver private_xform data. 215 * 216 * @param dev 217 * Compressdev device 218 * @param xform 219 * xform data 220 * @param private_xform 221 * ptr where handle of pmd's private_xform data should be stored 222 * @return 223 * - if successful returns 0 224 * and valid private_xform handle 225 * - <0 in error cases 226 * - Returns -EINVAL if input parameters are invalid. 227 * - Returns -ENOTSUP if comp device does not support the comp transform. 228 * - Returns -ENOMEM if the private_xform could not be allocated. 229 */ 230 typedef int (*compressdev_private_xform_create_t)(struct rte_compressdev *dev, 231 const struct rte_comp_xform *xform, void **private_xform); 232 233 /** 234 * Free driver private_xform data. 235 * 236 * @param dev 237 * Compressdev device 238 * @param private_xform 239 * handle of pmd's private_xform data 240 * @return 241 * - 0 if successful 242 * - <0 in error cases 243 * - Returns -EINVAL if input parameters are invalid. 244 * - Returns -EBUSY if can't free private_xform due to inflight operations 245 */ 246 typedef int (*compressdev_private_xform_free_t)(struct rte_compressdev *dev, 247 void *private_xform); 248 249 /** comp device operations function pointer table */ 250 struct rte_compressdev_ops { 251 compressdev_configure_t dev_configure; /**< Configure device. */ 252 compressdev_start_t dev_start; /**< Start device. */ 253 compressdev_stop_t dev_stop; /**< Stop device. */ 254 compressdev_close_t dev_close; /**< Close device. */ 255 256 compressdev_info_get_t dev_infos_get; /**< Get device info. */ 257 258 compressdev_stats_get_t stats_get; 259 /**< Get device statistics. */ 260 compressdev_stats_reset_t stats_reset; 261 /**< Reset device statistics. */ 262 263 compressdev_queue_pair_setup_t queue_pair_setup; 264 /**< Set up a device queue pair. */ 265 compressdev_queue_pair_release_t queue_pair_release; 266 /**< Release a queue pair. */ 267 268 compressdev_stream_create_t stream_create; 269 /**< Create a comp stream and initialise its private data. */ 270 compressdev_stream_free_t stream_free; 271 /**< Free a comp stream's private data. */ 272 273 compressdev_private_xform_create_t private_xform_create; 274 /**< Create a comp private_xform and initialise its private data. */ 275 compressdev_private_xform_free_t private_xform_free; 276 /**< Free a comp private_xform's data. */ 277 }; 278 279 /** 280 * @internal 281 * 282 * Function for internal use by dummy drivers primarily, e.g. ring-based 283 * driver. 284 * Allocates a new compressdev slot for an comp device and returns the pointer 285 * to that slot for the driver to use. 286 * 287 * @param name 288 * Unique identifier name for each device 289 * @param socket_id 290 * Socket to allocate resources on 291 * @return 292 * - Slot in the rte_dev_devices array for a new device; 293 */ 294 __rte_experimental 295 struct rte_compressdev * 296 rte_compressdev_pmd_allocate(const char *name, int socket_id); 297 298 /** 299 * @internal 300 * 301 * Function for internal use by dummy drivers primarily, e.g. ring-based 302 * driver. 303 * Release the specified compressdev device. 304 * 305 * @param dev 306 * Compress device 307 * @return 308 * - 0 on success, negative on error 309 */ 310 __rte_experimental 311 int 312 rte_compressdev_pmd_release_device(struct rte_compressdev *dev); 313 314 315 /** 316 * @internal 317 * 318 * PMD assist function to parse initialisation arguments for comp driver 319 * when creating a new comp PMD device instance. 320 * 321 * PMD should set default values for that PMD before calling function, 322 * these default values will be over-written with successfully parsed values 323 * from args string. 324 * 325 * @param params 326 * Parsed PMD initialisation parameters 327 * @param args 328 * Input argument string to parse 329 * @return 330 * - 0 on success 331 * - errno on failure 332 */ 333 __rte_experimental 334 int 335 rte_compressdev_pmd_parse_input_args( 336 struct rte_compressdev_pmd_init_params *params, 337 const char *args); 338 339 /** 340 * @internal 341 * 342 * PMD assist function to provide boiler plate code for comp driver to create 343 * and allocate resources for a new comp PMD device instance. 344 * 345 * @param name 346 * Compress device name 347 * @param device 348 * Base device instance 349 * @param params 350 * PMD initialisation parameters 351 * @return 352 * - comp device instance on success 353 * - NULL on creation failure 354 */ 355 __rte_experimental 356 struct rte_compressdev * 357 rte_compressdev_pmd_create(const char *name, 358 struct rte_device *device, 359 size_t private_data_size, 360 struct rte_compressdev_pmd_init_params *params); 361 362 /** 363 * @internal 364 * 365 * PMD assist function to provide boiler plate code for comp driver to 366 * destroy and free resources associated with a comp PMD device instance. 367 * 368 * @param dev 369 * Compress device 370 * @return 371 * - 0 on success 372 * - errno on failure 373 */ 374 __rte_experimental 375 int 376 rte_compressdev_pmd_destroy(struct rte_compressdev *dev); 377 378 #ifdef __cplusplus 379 } 380 #endif 381 382 #endif /* _RTE_COMPRESSDEV_PMD_H_ */ 383