1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2019-2021 Broadcom
10 #include "tf_session.h"
12 #include "tf_em_common.h"
14 #include "hcapi_cfa_defs.h"
16 #define TF_EM_MIN_ENTRIES (1 << 15) /* 32K */
17 #define TF_EM_MAX_ENTRIES (1 << 27) /* 128M */
19 #define TF_P4_HW_EM_KEY_MAX_SIZE 52
20 #define TF_P4_EM_KEY_RECORD_SIZE 64
22 #define TF_P58_HW_EM_KEY_MAX_SIZE 80
24 #define TF_EM_MAX_MASK 0x7FFF
25 #define TF_EM_MAX_ENTRY (128 * 1024 * 1024)
28 * Hardware Page sizes supported for EEM:
29 * 4K, 8K, 64K, 256K, 1M, 2M, 4M, 1G.
31 * Round-down other page sizes to the lower hardware page
34 #define TF_EM_PAGE_SIZE_4K 12
35 #define TF_EM_PAGE_SIZE_8K 13
36 #define TF_EM_PAGE_SIZE_64K 16
37 #define TF_EM_PAGE_SIZE_256K 18
38 #define TF_EM_PAGE_SIZE_1M 20
39 #define TF_EM_PAGE_SIZE_2M 21
40 #define TF_EM_PAGE_SIZE_4M 22
41 #define TF_EM_PAGE_SIZE_1G 30
44 #define BNXT_TF_PAGE_SIZE TF_EM_PAGE_SIZE_2M
46 #if (BNXT_TF_PAGE_SIZE == TF_EM_PAGE_SIZE_4K) /** 4K */
47 #define TF_EM_PAGE_SHIFT TF_EM_PAGE_SIZE_4K
48 #define TF_EM_PAGE_SIZE_ENUM HWRM_TF_CTXT_MEM_RGTR_INPUT_PAGE_SIZE_4K
49 #elif (BNXT_TF_PAGE_SIZE == TF_EM_PAGE_SIZE_8K) /** 8K */
50 #define TF_EM_PAGE_SHIFT TF_EM_PAGE_SIZE_8K
51 #define TF_EM_PAGE_SIZE_ENUM HWRM_TF_CTXT_MEM_RGTR_INPUT_PAGE_SIZE_8K
52 #elif (BNXT_TF_PAGE_SIZE == TF_EM_PAGE_SIZE_64K) /** 64K */
53 #define TF_EM_PAGE_SHIFT TF_EM_PAGE_SIZE_64K
54 #define TF_EM_PAGE_SIZE_ENUM HWRM_TF_CTXT_MEM_RGTR_INPUT_PAGE_SIZE_64K
55 #elif (BNXT_TF_PAGE_SIZE == TF_EM_PAGE_SIZE_256K) /** 256K */
56 #define TF_EM_PAGE_SHIFT TF_EM_PAGE_SIZE_256K
57 #define TF_EM_PAGE_SIZE_ENUM HWRM_TF_CTXT_MEM_RGTR_INPUT_PAGE_SIZE_256K
58 #elif (BNXT_TF_PAGE_SIZE == TF_EM_PAGE_SIZE_1M) /** 1M */
59 #define TF_EM_PAGE_SHIFT TF_EM_PAGE_SIZE_1M
60 #define TF_EM_PAGE_SIZE_ENUM HWRM_TF_CTXT_MEM_RGTR_INPUT_PAGE_SIZE_1M
61 #elif (BNXT_TF_PAGE_SIZE == TF_EM_PAGE_SIZE_2M) /** 2M */
62 #define TF_EM_PAGE_SHIFT TF_EM_PAGE_SIZE_2M
63 #define TF_EM_PAGE_SIZE_ENUM HWRM_TF_CTXT_MEM_RGTR_INPUT_PAGE_SIZE_2M
64 #elif (BNXT_TF_PAGE_SIZE == TF_EM_PAGE_SIZE_4M) /** 4M */
65 #define TF_EM_PAGE_SHIFT TF_EM_PAGE_SIZE_4M
66 #define TF_EM_PAGE_SIZE_ENUM HWRM_TF_CTXT_MEM_RGTR_INPUT_PAGE_SIZE_4M
67 #elif (BNXT_TF_PAGE_SIZE == TF_EM_PAGE_SIZE_1G) /** 1G */
68 #define TF_EM_PAGE_SHIFT TF_EM_PAGE_SIZE_1G
69 #define TF_EM_PAGE_SIZE_ENUM HWRM_TF_CTXT_MEM_RGTR_INPUT_PAGE_SIZE_1G
71 #error "Invalid Page Size specified. Please use a TF_EM_PAGE_SIZE_n define"
75 * System memory always uses 4K pages
77 #define TF_EM_PAGE_SIZE (1 << TF_EM_PAGE_SHIFT)
78 #define TF_EM_PAGE_ALIGNMENT (1 << TF_EM_PAGE_SHIFT)
88 * E = Entry (bucket index)
90 #define TF_EM_INTERNAL_INDEX_SHIFT 2
91 #define TF_EM_INTERNAL_INDEX_MASK 0xFFFC
92 #define TF_EM_INTERNAL_ENTRY_MASK 0x3
95 * Each EM entry is 512-bit (64-bytes) but ordered differently to
98 struct tf_em_64b_entry {
99 /** Header is 8 bytes long */
100 struct cfa_p4_eem_entry_hdr hdr;
101 /** Key is 448 bits - 56 bytes */
102 uint8_t key[TF_P4_EM_KEY_RECORD_SIZE - sizeof(struct cfa_p4_eem_entry_hdr)];
109 TF_EEM_MEM_TYPE_INVALID,
110 TF_EEM_MEM_TYPE_HOST,
111 TF_EEM_MEM_TYPE_SYSTEM
115 * tf_em_cfg_parms definition
117 struct tf_em_cfg_parms {
119 * [in] Num entries in resource config
121 uint16_t num_elements;
123 * [in] Resource config
125 struct tf_rm_element_cfg *cfg;
127 * Session resource allocations
129 struct tf_session_resources *resources;
133 enum tf_mem_type mem_type;
143 struct rm_db *em_db[TF_DIR_MAX];
149 * @ref tf_alloc_eem_tbl_scope
151 * @ref tf_free_eem_tbl_scope_cb
153 * @ref tf_em_insert_int_entry
155 * @ref tf_em_delete_int_entry
157 * @ref tf_em_insert_ext_entry
159 * @ref tf_em_delete_ext_entry
161 * @ref tf_em_insert_ext_sys_entry
163 * @ref tf_em_delete_ext_sys_entry
165 * @ref tf_em_int_bind
167 * @ref tf_em_int_unbind
169 * @ref tf_em_ext_common_bind
171 * @ref tf_em_ext_common_unbind
173 * @ref tf_em_ext_alloc
175 * @ref tf_em_ext_free
177 * @ref tf_em_ext_common_free
179 * @ref tf_em_ext_common_alloc
183 * Insert record in to internal EM table
186 * Pointer to TruFlow handle
189 * Pointer to input parameters
193 * -EINVAL - Parameter error
195 int tf_em_insert_int_entry(struct tf *tfp,
196 struct tf_insert_em_entry_parms *parms);
199 * Delete record from internal EM table
202 * Pointer to TruFlow handle
205 * Pointer to input parameters
209 * -EINVAL - Parameter error
211 int tf_em_delete_int_entry(struct tf *tfp,
212 struct tf_delete_em_entry_parms *parms);
215 * Insert record in to internal EM table
218 * Pointer to TruFlow handle
221 * Pointer to input parameters
225 * -EINVAL - Parameter error
227 int tf_em_hash_insert_int_entry(struct tf *tfp,
228 struct tf_insert_em_entry_parms *parms);
231 * Delete record from internal EM table
234 * Pointer to TruFlow handle
237 * Pointer to input parameters
241 * -EINVAL - Parameter error
243 int tf_em_hash_delete_int_entry(struct tf *tfp,
244 struct tf_delete_em_entry_parms *parms);
247 * Move record from internal EM table
250 * Pointer to TruFlow handle
253 * Pointer to input parameters
257 * -EINVAL - Parameter error
259 int tf_em_move_int_entry(struct tf *tfp,
260 struct tf_move_em_entry_parms *parms);
263 * Insert record in to external EEM table
266 * Pointer to TruFlow handle
269 * Pointer to input parameters
273 * -EINVAL - Parameter error
275 int tf_em_insert_ext_entry(struct tf *tfp,
276 struct tf_insert_em_entry_parms *parms);
279 * Insert record from external EEM table
282 * Pointer to TruFlow handle
285 * Pointer to input parameters
289 * -EINVAL - Parameter error
291 int tf_em_delete_ext_entry(struct tf *tfp,
292 struct tf_delete_em_entry_parms *parms);
295 * Insert record in to external system EEM table
298 * Pointer to TruFlow handle
301 * Pointer to input parameters
305 * -EINVAL - Parameter error
307 int tf_em_insert_ext_sys_entry(struct tf *tfp,
308 struct tf_insert_em_entry_parms *parms);
311 * Delete record from external system EEM table
314 * Pointer to TruFlow handle
317 * Pointer to input parameters
321 * -EINVAL - Parameter error
323 int tf_em_delete_ext_sys_entry(struct tf *tfp,
324 struct tf_delete_em_entry_parms *parms);
327 * Bind internal EM device interface
330 * Pointer to TruFlow handle
333 * Pointer to input parameters
337 * -EINVAL - Parameter error
339 int tf_em_int_bind(struct tf *tfp,
340 struct tf_em_cfg_parms *parms);
343 * Unbind internal EM device interface
346 * Pointer to TruFlow handle
349 * Pointer to input parameters
353 * -EINVAL - Parameter error
355 int tf_em_int_unbind(struct tf *tfp);
358 * Common bind for EEM device interface. Used for both host and
362 * Pointer to TruFlow handle
365 * Pointer to input parameters
369 * -EINVAL - Parameter error
371 int tf_em_ext_common_bind(struct tf *tfp,
372 struct tf_em_cfg_parms *parms);
375 * Common unbind for EEM device interface. Used for both host and
379 * Pointer to TruFlow handle
382 * Pointer to input parameters
386 * -EINVAL - Parameter error
388 int tf_em_ext_common_unbind(struct tf *tfp);
391 * Alloc for external EEM using host memory
394 * Pointer to TruFlow handle
397 * Pointer to input parameters
401 * -EINVAL - Parameter error
403 int tf_em_ext_alloc(struct tf *tfp,
404 struct tf_alloc_tbl_scope_parms *parms);
407 * Free for external EEM using host memory
410 * Pointer to TruFlow handle
413 * Pointer to input parameters
417 * -EINVAL - Parameter error
419 int tf_em_ext_free(struct tf *tfp,
420 struct tf_free_tbl_scope_parms *parms);
423 * Common free table scope for external EEM using host or system memory
426 * Pointer to TruFlow handle
429 * Pointer to input parameters
433 * -EINVAL - Parameter error
435 int tf_em_ext_common_free(struct tf *tfp,
436 struct tf_free_tbl_scope_parms *parms);
439 * Common alloc table scope for external EEM using host or system memory
442 * Pointer to TruFlow handle
445 * Pointer to input parameters
449 * -EINVAL - Parameter error
451 int tf_em_ext_common_alloc(struct tf *tfp,
452 struct tf_alloc_tbl_scope_parms *parms);
454 * Map a set of parifs to a set of EEM base addresses (table scope)
457 * Pointer to TruFlow handle
460 * Pointer to input parameters
464 * -EINVAL - Parameter error
466 int tf_em_ext_map_tbl_scope(struct tf *tfp,
467 struct tf_map_tbl_scope_parms *parms);
470 * Allocate External Tbl entry from the scope pool.
473 * Pointer to Truflow Handle
475 * Allocation parameters
478 * 0 - Success, entry allocated - no search support
479 * -ENOMEM -EINVAL -EOPNOTSUPP
480 * - Failure, entry not allocated, out of resources
483 tf_tbl_ext_alloc(struct tf *tfp,
484 struct tf_tbl_alloc_parms *parms);
487 * Free External Tbl entry to the scope pool.
490 * Pointer to Truflow Handle
492 * Allocation parameters
495 * 0 - Success, entry freed
497 * - Failure, entry not successfully freed for these reasons
503 tf_tbl_ext_free(struct tf *tfp,
504 struct tf_tbl_free_parms *parms);
507 * Sets the specified external table type element.
509 * This API sets the specified element data by invoking the
513 * Pointer to TF handle
516 * Pointer to table set parameters
519 * - (0) if successful.
520 * - (-EINVAL) on failure.
522 int tf_tbl_ext_common_set(struct tf *tfp,
523 struct tf_tbl_set_parms *parms);
526 * Sets the specified external table type element.
528 * This API sets the specified element data by invoking the
532 * Pointer to TF handle
535 * Pointer to table set parameters
538 * - (0) if successful.
539 * - (-EINVAL) on failure.
541 int tf_tbl_ext_set(struct tf *tfp,
542 struct tf_tbl_set_parms *parms);
545 tf_em_ext_system_bind(struct tf *tfp,
546 struct tf_em_cfg_parms *parms);
548 int offload_system_mmap(struct tf_tbl_scope_cb *tbl_scope_cb);
551 * Retrieves the allocated resource info
554 * Pointer to TF handle, used for HCAPI communication
557 * Pointer to parameters
560 * - (0) if successful.
561 * - (-EINVAL) on failure.
564 tf_em_get_resc_info(struct tf *tfp,
565 struct tf_em_resource_info *em);
566 #endif /* _TF_EM_H_ */