drivers/net/bnxt/tf_core/tf_core.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2019-2020 Broadcom
   3  * All rights reserved.
   4  */
   5
   6 #ifndef _TF_CORE_H_
   7 #define _TF_CORE_H_
   8
   9 #include <stdint.h>
  10 #include <stdlib.h>
  11 #include <stdbool.h>
  12 #include <stdio.h>
  13
  14 #include "tf_project.h"
  15
  16 /**
  17  * @file
  18  *
  19  * Truflow Core API Header File
  20  */
  21
  22 /********** BEGIN Truflow Core DEFINITIONS **********/
  23
  24
  25 #define TF_KILOBYTE  1024
  26 #define TF_MEGABYTE  (1024 * 1024)
  27
  28 /**
  29  * direction
  30  */
  31 enum tf_dir {
  32         TF_DIR_RX,  /**< Receive */
  33         TF_DIR_TX,  /**< Transmit */
  34         TF_DIR_MAX
  35 };
  36
  37 /**
  38  * memory choice
  39  */
  40 enum tf_mem {
  41         TF_MEM_INTERNAL, /**< Internal */
  42         TF_MEM_EXTERNAL, /**< External */
  43         TF_MEM_MAX
  44 };
  45
  46 /**
  47  * EEM record AR helper
  48  *
  49  * Helper to handle the Action Record Pointer in the EEM Record Entry.
  50  *
  51  * Convert absolute offset to action record pointer in EEM record entry
  52  * Convert action record pointer in EEM record entry to absolute offset
  53  */
  54 #define TF_ACT_REC_OFFSET_2_PTR(offset) ((offset) >> 4)
  55 #define TF_ACT_REC_PTR_2_OFFSET(offset) ((offset) << 4)
  56
  57 /*
  58  * Helper Macros
  59  */
  60 #define TF_BITS_2_BYTES(num_bits) (((num_bits) + 7) / 8)
  61
  62 /********** BEGIN API FUNCTION PROTOTYPES/PARAMETERS **********/
  63
  64 /**
  65  * @page general General
  66  *
  67  * @ref tf_open_session
  68  *
  69  * @ref tf_attach_session
  70  *
  71  * @ref tf_close_session
  72  */
  73
  74
  75 /**
  76  * Session Version defines
  77  *
  78  * The version controls the format of the tf_session and
  79  * tf_session_info structure. This is to assure upgrade between
  80  * versions can be supported.
  81  */
  82 #define TF_SESSION_VER_MAJOR  1   /**< Major Version */
  83 #define TF_SESSION_VER_MINOR  0   /**< Minor Version */
  84 #define TF_SESSION_VER_UPDATE 0   /**< Update Version */
  85
  86 /**
  87  * Session Name
  88  *
  89  * Name of the TruFlow control channel interface.  Expects
  90  * format to be RTE Name specific, i.e. rte_eth_dev_get_name_by_port()
  91  */
  92 #define TF_SESSION_NAME_MAX       64
  93
  94 #define TF_FW_SESSION_ID_INVALID  0xFF  /**< Invalid FW Session ID define */
  95
  96 /**
  97  * Session Identifier
  98  *
  99  * Unique session identifier which includes PCIe bus info to
 100  * distinguish the PF and session info to identify the associated
 101  * TruFlow session. Session ID is constructed from the passed in
 102  * ctrl_chan_name in tf_open_session() together with an allocated
 103  * fw_session_id. Done by TruFlow on tf_open_session().
 104  */
 105 union tf_session_id {
 106         uint32_t id;
 107         struct {
 108                 uint8_t domain;
 109                 uint8_t bus;
 110                 uint8_t device;
 111                 uint8_t fw_session_id;
 112         } internal;
 113 };
 114
 115 /**
 116  * Session Version
 117  *
 118  * The version controls the format of the tf_session and
 119  * tf_session_info structure. This is to assure upgrade between
 120  * versions can be supported.
 121  *
 122  * Please see the TF_VER_MAJOR/MINOR and UPDATE defines.
 123  */
 124 struct tf_session_version {
 125         uint8_t major;
 126         uint8_t minor;
 127         uint8_t update;
 128 };
 129
 130 /**
 131  * Session supported device types
 132  */
 133 enum tf_device_type {
 134         TF_DEVICE_TYPE_WH = 0, /**< Whitney+  */
 135         TF_DEVICE_TYPE_BRD2,   /**< TBD       */
 136         TF_DEVICE_TYPE_BRD3,   /**< TBD       */
 137         TF_DEVICE_TYPE_BRD4,   /**< TBD       */
 138         TF_DEVICE_TYPE_MAX     /**< Maximum   */
 139 };
 140
 141 /** Identifier resource types
 142  */
 143 enum tf_identifier_type {
 144         /** The L2 Context is returned from the L2 Ctxt TCAM lookup
 145          *  and can be used in WC TCAM or EM keys to virtualize further
 146          *  lookups.
 147          */
 148         TF_IDENT_TYPE_L2_CTXT,
 149         /** The WC profile func is returned from the L2 Ctxt TCAM lookup
 150          *  to enable virtualization of the profile TCAM.
 151          */
 152         TF_IDENT_TYPE_PROF_FUNC,
 153         /** The WC profile ID is included in the WC lookup key
 154          *  to enable virtualization of the WC TCAM hardware.
 155          */
 156         TF_IDENT_TYPE_WC_PROF,
 157         /** The EM profile ID is included in the EM lookup key
 158          *  to enable virtualization of the EM hardware. (not required for SR2
 159          *  as it has table scope)
 160          */
 161         TF_IDENT_TYPE_EM_PROF,
 162         /** The L2 func is included in the ILT result and from recycling to
 163          *  enable virtualization of further lookups.
 164          */
 165         TF_IDENT_TYPE_L2_FUNC,
 166         TF_IDENT_TYPE_MAX
 167 };
 168
 169 /**
 170  * Enumeration of TruFlow table types. A table type is used to identify a
 171  * resource object.
 172  *
 173  * NOTE: The table type TF_TBL_TYPE_EXT is unique in that it is
 174  * the only table type that is connected with a table scope.
 175  */
 176 enum tf_tbl_type {
 177         /* Internal */
 178
 179         /** Wh+/SR Action Record */
 180         TF_TBL_TYPE_FULL_ACT_RECORD,
 181         /** Wh+/SR/Th Multicast Groups */
 182         TF_TBL_TYPE_MCAST_GROUPS,
 183         /** Wh+/SR Action Encap 8 Bytes */
 184         TF_TBL_TYPE_ACT_ENCAP_8B,
 185         /** Wh+/SR Action Encap 16 Bytes */
 186         TF_TBL_TYPE_ACT_ENCAP_16B,
 187         /** Action Encap 32 Bytes */
 188         TF_TBL_TYPE_ACT_ENCAP_32B,
 189         /** Wh+/SR Action Encap 64 Bytes */
 190         TF_TBL_TYPE_ACT_ENCAP_64B,
 191         /** Action Source Properties SMAC */
 192         TF_TBL_TYPE_ACT_SP_SMAC,
 193         /** Wh+/SR Action Source Properties SMAC IPv4 */
 194         TF_TBL_TYPE_ACT_SP_SMAC_IPV4,
 195         /** Action Source Properties SMAC IPv6 */
 196         TF_TBL_TYPE_ACT_SP_SMAC_IPV6,
 197         /** Wh+/SR Action Statistics 64 Bits */
 198         TF_TBL_TYPE_ACT_STATS_64,
 199         /** Wh+/SR Action Modify L4 Src Port */
 200         TF_TBL_TYPE_ACT_MODIFY_SPORT,
 201         /** Wh+/SR Action Modify L4 Dest Port */
 202         TF_TBL_TYPE_ACT_MODIFY_DPORT,
 203         /** Wh+/SR Action Modify IPv4 Source */
 204         TF_TBL_TYPE_ACT_MODIFY_IPV4_SRC,
 205         /** Wh+/SR Action _Modify L4 Dest Port */
 206         TF_TBL_TYPE_ACT_MODIFY_IPV4_DEST,
 207         /** Action Modify IPv6 Source */
 208         TF_TBL_TYPE_ACT_MODIFY_IPV6_SRC,
 209         /** Action Modify IPv6 Destination */
 210         TF_TBL_TYPE_ACT_MODIFY_IPV6_DEST,
 211         /** Meter Profiles */
 212         TF_TBL_TYPE_METER_PROF,
 213         /** Meter Instance */
 214         TF_TBL_TYPE_METER_INST,
 215         /** Mirror Config */
 216         TF_TBL_TYPE_MIRROR_CONFIG,
 217         /** UPAR */
 218         TF_TBL_TYPE_UPAR,
 219         /** SR2 Epoch 0 table */
 220         TF_TBL_TYPE_EPOCH0,
 221         /** SR2 Epoch 1 table  */
 222         TF_TBL_TYPE_EPOCH1,
 223         /** SR2 Metadata  */
 224         TF_TBL_TYPE_METADATA,
 225         /** SR2 CT State  */
 226         TF_TBL_TYPE_CT_STATE,
 227         /** SR2 Range Profile  */
 228         TF_TBL_TYPE_RANGE_PROF,
 229         /** SR2 Range Entry  */
 230         TF_TBL_TYPE_RANGE_ENTRY,
 231         /** SR2 LAG Entry  */
 232         TF_TBL_TYPE_LAG,
 233         /** SR2 VNIC/SVIF Table */
 234         TF_TBL_TYPE_VNIC_SVIF,
 235         /** Th/SR2 EM Flexible Key builder */
 236         TF_TBL_TYPE_EM_FKB,
 237         /** Th/SR2 WC Flexible Key builder */
 238         TF_TBL_TYPE_WC_FKB,
 239
 240         /* External */
 241
 242         /** External table type - initially 1 poolsize entries.
 243          * All External table types are associated with a table
 244          * scope. Internal types are not.
 245          */
 246         TF_TBL_TYPE_EXT,
 247         TF_TBL_TYPE_MAX
 248 };
 249
 250 /**
 251  * TCAM table type
 252  */
 253 enum tf_tcam_tbl_type {
 254         /** L2 Context TCAM */
 255         TF_TCAM_TBL_TYPE_L2_CTXT_TCAM,
 256         /** Profile TCAM */
 257         TF_TCAM_TBL_TYPE_PROF_TCAM,
 258         /** Wildcard TCAM */
 259         TF_TCAM_TBL_TYPE_WC_TCAM,
 260         /** Source Properties TCAM */
 261         TF_TCAM_TBL_TYPE_SP_TCAM,
 262         /** Connection Tracking Rule TCAM */
 263         TF_TCAM_TBL_TYPE_CT_RULE_TCAM,
 264         /** Virtual Edge Bridge TCAM */
 265         TF_TCAM_TBL_TYPE_VEB_TCAM,
 266         TF_TCAM_TBL_TYPE_MAX
 267 };
 268
 269 /**
 270  * EM Resources
 271  * These defines are provisioned during
 272  * tf_open_session()
 273  */
 274 enum tf_em_tbl_type {
 275         /** The number of internal EM records for the session */
 276         TF_EM_TBL_TYPE_EM_RECORD,
 277         /** The number of table scopes reequested */
 278         TF_EM_TBL_TYPE_TBL_SCOPE,
 279         TF_EM_TBL_TYPE_MAX
 280 };
 281
 282 /** TruFlow Session Information
 283  *
 284  * Structure defining a TruFlow Session, also known as a Management
 285  * session. This structure is initialized at time of
 286  * tf_open_session(). It is passed to all of the TruFlow APIs as way
 287  * to prescribe and isolate resources between different TruFlow ULP
 288  * Applications.
 289  */
 290 struct tf_session_info {
 291         /**
 292          * TrueFlow Version. Used to control the structure layout when
 293          * sharing sessions. No guarantee that a secondary process
 294          * would come from the same version of an executable.
 295          * TruFlow initializes this variable on tf_open_session().
 296          *
 297          * Owner:  TruFlow
 298          * Access: TruFlow
 299          */
 300         struct tf_session_version ver;
 301         /**
 302          * will be STAILQ_ENTRY(tf_session_info) next
 303          *
 304          * Owner:  ULP
 305          * Access: ULP
 306          */
 307         void                 *next;
 308         /**
 309          * Session ID is a unique identifier for the session. TruFlow
 310          * initializes this variable during tf_open_session()
 311          * processing.
 312          *
 313          * Owner:  TruFlow
 314          * Access: Truflow & ULP
 315          */
 316         union tf_session_id   session_id;
 317         /**
 318          * Protects access to core_data. Lock is initialized and owned
 319          * by ULP. TruFlow can access the core_data without checking
 320          * the lock.
 321          *
 322          * Owner:  ULP
 323          * Access: ULP
 324          */
 325         uint8_t               spin_lock;
 326         /**
 327          * The core_data holds the TruFlow tf_session data
 328          * structure. This memory is allocated and owned by TruFlow on
 329          * tf_open_session().
 330          *
 331          * TruFlow uses this memory for session management control
 332          * until the session is closed by ULP. Access control is done
 333          * by the spin_lock which ULP controls ahead of TruFlow API
 334          * calls.
 335          *
 336          * Please see tf_open_session_parms for specification details
 337          * on this variable.
 338          *
 339          * Owner:  TruFlow
 340          * Access: TruFlow
 341          */
 342         void                 *core_data;
 343         /**
 344          * The core_data_sz_bytes specifies the size of core_data in
 345          * bytes.
 346          *
 347          * The size is set by TruFlow on tf_open_session().
 348          *
 349          * Please see tf_open_session_parms for specification details
 350          * on this variable.
 351          *
 352          * Owner:  TruFlow
 353          * Access: TruFlow
 354          */
 355         uint32_t              core_data_sz_bytes;
 356 };
 357
 358 /** TruFlow handle
 359  *
 360  * Contains a pointer to the session info. Allocated by ULP and passed
 361  * to TruFlow using tf_open_session(). TruFlow will populate the
 362  * session info at that time. Additional 'opens' can be done using
 363  * same session_info by using tf_attach_session().
 364  *
 365  * It is expected that ULP allocates this memory as shared memory.
 366  *
 367  * NOTE: This struct must be within the BNXT PMD struct bnxt
 368  *       (bp). This allows use of container_of() to get access to the PMD.
 369  */
 370 struct tf {
 371         struct tf_session_info *session;
 372 };
 373
 374 /**
 375  * tf_session_resources parameter definition.
 376  */
 377 struct tf_session_resources {
 378         /** [in] Requested Identifier Resources
 379          *
 380          * The number of identifier resources requested for the session.
 381          * The index used is tf_identifier_type.
 382          */
 383         uint16_t identifer_cnt[TF_DIR_MAX][TF_IDENT_TYPE_MAX];
 384         /** [in] Requested Index Table resource counts
 385          *
 386          * The number of index table resources requested for the session.
 387          * The index used is tf_tbl_type.
 388          */
 389         uint16_t tbl_cnt[TF_TBL_TYPE_MAX][TF_DIR_MAX];
 390         /** [in] Requested TCAM Table resource counts
 391          *
 392          * The number of TCAM table resources requested for the session.
 393          * The index used is tf_tcam_tbl_type.
 394          */
 395         uint16_t tcam_tbl_cnt[TF_TCAM_TBL_TYPE_MAX][TF_DIR_MAX];
 396         /** [in] Requested EM resource counts
 397          *
 398          * The number of internal EM table resources requested for the session
 399          * The index used is tf_em_tbl_type.
 400          */
 401         uint16_t em_tbl_cnt[TF_EM_TBL_TYPE_MAX][TF_DIR_MAX];
 402 };
 403
 404 /**
 405  * tf_open_session parameters definition.
 406  */
 407 struct tf_open_session_parms {
 408         /** [in] ctrl_chan_name
 409          *
 410          * String containing name of control channel interface to be
 411          * used for this session to communicate with firmware.
 412          *
 413          * The ctrl_chan_name can be looked up by using
 414          * rte_eth_dev_get_name_by_port() within the ULP.
 415          *
 416          * ctrl_chan_name will be used as part of a name for any
 417          * shared memory allocation.
 418          */
 419         char ctrl_chan_name[TF_SESSION_NAME_MAX];
 420         /** [in] shadow_copy
 421          *
 422          * Boolean controlling the use and availability of shadow
 423          * copy. Shadow copy will allow the TruFlow to keep track of
 424          * resource content on the firmware side without having to
 425          * query firmware. Additional private session core_data will
 426          * be allocated if this boolean is set to 'true', default
 427          * 'false'.
 428          *
 429          * Size of memory depends on the NVM Resource settings for the
 430          * control channel.
 431          */
 432         bool shadow_copy;
 433         /** [in/out] session_id
 434          *
 435          * Session_id is unique per session.
 436          *
 437          * Session_id is composed of domain, bus, device and
 438          * fw_session_id. The construction is done by parsing the
 439          * ctrl_chan_name together with allocation of a fw_session_id.
 440          *
 441          * The session_id allows a session to be shared between devices.
 442          */
 443         union tf_session_id session_id;
 444         /** [in] device type
 445          *
 446          * Device type is passed, one of Wh+, SR, Thor, SR2
 447          */
 448         enum tf_device_type device_type;
 449         /** [in] resources
 450          *
 451          * Resource allocation
 452          */
 453         struct tf_session_resources resources;
 454 };
 455
 456 /**
 457  * Opens a new TruFlow management session.
 458  *
 459  * TruFlow will allocate session specific memory, shared memory, to
 460  * hold its session data. This data is private to TruFlow.
 461  *
 462  * Multiple PFs can share the same session. An association, refcount,
 463  * between session and PFs is maintained within TruFlow. Thus, a PF
 464  * can attach to an existing session, see tf_attach_session().
 465  *
 466  * No other TruFlow APIs will succeed unless this API is first called and
 467  * succeeds.
 468  *
 469  * tf_open_session() returns a session id that can be used on attach.
 470  *
 471  * [in] tfp
 472  *   Pointer to TF handle
 473  * [in] parms
 474  *   Pointer to open parameters
 475  *
 476  * Returns
 477  *   - (0) if successful.
 478  *   - (-EINVAL) on failure.
 479  */
 480 int tf_open_session(struct tf *tfp,
 481                     struct tf_open_session_parms *parms);
 482
 483 struct tf_attach_session_parms {
 484         /** [in] ctrl_chan_name
 485          *
 486          * String containing name of control channel interface to be
 487          * used for this session to communicate with firmware.
 488          *
 489          * The ctrl_chan_name can be looked up by using
 490          * rte_eth_dev_get_name_by_port() within the ULP.
 491          *
 492          * ctrl_chan_name will be used as part of a name for any
 493          * shared memory allocation.
 494          */
 495         char ctrl_chan_name[TF_SESSION_NAME_MAX];
 496
 497         /** [in] attach_chan_name
 498          *
 499          * String containing name of attach channel interface to be
 500          * used for this session.
 501          *
 502          * The attach_chan_name must be given to a 2nd process after
 503          * the primary process has been created. This is the
 504          * ctrl_chan_name of the primary process and is used to find
 505          * the shared memory for the session that the attach is going
 506          * to use.
 507          */
 508         char attach_chan_name[TF_SESSION_NAME_MAX];
 509
 510         /** [in] session_id
 511          *
 512          * Session_id is unique per session. For Attach the session_id
 513          * should be the session_id that was returned on the first
 514          * open.
 515          *
 516          * Session_id is composed of domain, bus, device and
 517          * fw_session_id. The construction is done by parsing the
 518          * ctrl_chan_name together with allocation of a fw_session_id
 519          * during tf_open_session().
 520          *
 521          * A reference count will be incremented on attach. A session
 522          * is first fully closed when reference count is zero by
 523          * calling tf_close_session().
 524          */
 525         union tf_session_id session_id;
 526 };
 527
 528 /**
 529  * Attaches to an existing session. Used when more than one PF wants
 530  * to share a single session. In that case all TruFlow management
 531  * traffic will be sent to the TruFlow firmware using the 'PF' that
 532  * did the attach not the session ctrl channel.
 533  *
 534  * Attach will increment a ref count as to manage the shared session data.
 535  *
 536  * [in] tfp, pointer to TF handle
 537  * [in] parms, pointer to attach parameters
 538  *
 539  * Returns
 540  *   - (0) if successful.
 541  *   - (-EINVAL) on failure.
 542  */
 543 int tf_attach_session(struct tf *tfp,
 544                       struct tf_attach_session_parms *parms);
 545
 546 /**
 547  * Closes an existing session. Cleans up all hardware and firmware
 548  * state associated with the TruFlow application session when the last
 549  * PF associated with the session results in refcount to be zero.
 550  *
 551  * Returns success or failure code.
 552  */
 553 int tf_close_session(struct tf *tfp);
 554
 555 /**
 556  * @page  ident Identity Management
 557  *
 558  * @ref tf_alloc_identifier
 559  *
 560  * @ref tf_free_identifier
 561  */
 562 /** tf_alloc_identifier parameter definition
 563  */
 564 struct tf_alloc_identifier_parms {
 565         /**
 566          * [in]  receive or transmit direction
 567          */
 568         enum tf_dir dir;
 569         /**
 570          * [in] Identifier type
 571          */
 572         enum tf_identifier_type ident_type;
 573         /**
 574          * [out] Identifier allocated
 575          */
 576         uint16_t id;
 577 };
 578
 579 /** tf_free_identifier parameter definition
 580  */
 581 struct tf_free_identifier_parms {
 582         /**
 583          * [in]  receive or transmit direction
 584          */
 585         enum tf_dir dir;
 586         /**
 587          * [in] Identifier type
 588          */
 589         enum tf_identifier_type ident_type;
 590         /**
 591          * [in] ID to free
 592          */
 593         uint16_t id;
 594 };
 595
 596 /** allocate identifier resource
 597  *
 598  * TruFlow core will allocate a free id from the per identifier resource type
 599  * pool reserved for the session during tf_open().  No firmware is involved.
 600  *
 601  * Returns success or failure code.
 602  */
 603 int tf_alloc_identifier(struct tf *tfp,
 604                         struct tf_alloc_identifier_parms *parms);
 605
 606 /** free identifier resource
 607  *
 608  * TruFlow core will return an id back to the per identifier resource type pool
 609  * reserved for the session.  No firmware is involved.  During tf_close, the
 610  * complete pool is returned to the firmware.
 611  *
 612  * Returns success or failure code.
 613  */
 614 int tf_free_identifier(struct tf *tfp,
 615                        struct tf_free_identifier_parms *parms);
 616
 617 /**
 618  * @page dram_table DRAM Table Scope Interface
 619  *
 620  * @ref tf_alloc_tbl_scope
 621  *
 622  * @ref tf_free_tbl_scope
 623  *
 624  * If we allocate the EEM memory from the core, we need to store it in
 625  * the shared session data structure to make sure it can be freed later.
 626  * (for example if the PF goes away)
 627  *
 628  * Current thought is that memory is allocated within core.
 629  */
 630
 631
 632 /** tf_alloc_tbl_scope_parms definition
 633  */
 634 struct tf_alloc_tbl_scope_parms {
 635         /**
 636          * [in] All Maximum key size required.
 637          */
 638         uint16_t rx_max_key_sz_in_bits;
 639         /**
 640          * [in] Maximum Action size required (includes inlined items)
 641          */
 642         uint16_t rx_max_action_entry_sz_in_bits;
 643         /**
 644          * [in] Memory size in Megabytes
 645          * Total memory size allocated by user to be divided
 646          * up for actions, hash, counters.  Only inline external actions.
 647          * Use this variable or the number of flows, do not set both.
 648          */
 649         uint32_t rx_mem_size_in_mb;
 650         /**
 651          * [in] Number of flows * 1000. If set, rx_mem_size_in_mb must equal 0.
 652          */
 653         uint32_t rx_num_flows_in_k;
 654         /**
 655          * [in] Brd4 only receive table access interface id
 656          */
 657         uint32_t rx_tbl_if_id;
 658         /**
 659          * [in] All Maximum key size required.
 660          */
 661         uint16_t tx_max_key_sz_in_bits;
 662         /**
 663          * [in] Maximum Action size required (includes inlined items)
 664          */
 665         uint16_t tx_max_action_entry_sz_in_bits;
 666         /**
 667          * [in] Memory size in Megabytes
 668          * Total memory size allocated by user to be divided
 669          * up for actions, hash, counters.  Only inline external actions.
 670          */
 671         uint32_t tx_mem_size_in_mb;
 672         /**
 673          * [in] Number of flows * 1000
 674          */
 675         uint32_t tx_num_flows_in_k;
 676         /**
 677          * [in] Brd4 only receive table access interface id
 678          */
 679         uint32_t tx_tbl_if_id;
 680         /**
 681          * [in] Flush pending HW cached flows every 1/10th of value
 682          * set in seconds, both idle and active flows are flushed
 683          * from the HW cache. If set to 0, this feature will be disabled.
 684          */
 685         uint8_t hw_flow_cache_flush_timer;
 686         /**
 687          * [out] table scope identifier
 688          */
 689         uint32_t tbl_scope_id;
 690 };
 691
 692 struct tf_free_tbl_scope_parms {
 693         /**
 694          * [in] table scope identifier
 695          */
 696         uint32_t tbl_scope_id;
 697 };
 698
 699 /**
 700  * allocate a table scope
 701  *
 702  * On Brd4 Firmware will allocate a scope ID.  On other devices, the scope
 703  * is a software construct to identify an EEM table.  This function will
 704  * divide the hash memory/buckets and records according to the device
 705  * device constraints based upon calculations using either the number of flows
 706  * requested or the size of memory indicated.  Other parameters passed in
 707  * determine the configuration (maximum key size, maximum external action record
 708  * size.
 709  *
 710  * This API will allocate the table region in
 711  * DRAM, program the PTU page table entries, and program the number of static
 712  * buckets (if Brd4) in the RX and TX CFAs.  Buckets are assumed to start at
 713  * 0 in the EM memory for the scope.  Upon successful completion of this API,
 714  * hash tables are fully initialized and ready for entries to be inserted.
 715  *
 716  * A single API is used to allocate a common table scope identifier in both
 717  * receive and transmit CFA. The scope identifier is common due to nature of
 718  * connection tracking sending notifications between RX and TX direction.
 719  *
 720  * The receive and transmit table access identifiers specify which rings will
 721  * be used to initialize table DRAM.  The application must ensure mutual
 722  * exclusivity of ring usage for table scope allocation and any table update
 723  * operations.
 724  *
 725  * The hash table buckets, EM keys, and EM lookup results are stored in the
 726  * memory allocated based on the rx_em_hash_mb/tx_em_hash_mb parameters.  The
 727  * hash table buckets are stored at the beginning of that memory.
 728  *
 729  * NOTE:  No EM internal setup is done here. On chip EM records are managed
 730  * internally by TruFlow core.
 731  *
 732  * Returns success or failure code.
 733  */
 734 int tf_alloc_tbl_scope(struct tf *tfp,
 735                        struct tf_alloc_tbl_scope_parms *parms);
 736
 737
 738 /**
 739  * free a table scope
 740  *
 741  * Firmware checks that the table scope ID is owned by the TruFlow
 742  * session, verifies that no references to this table scope remains
 743  * (Brd4 ILT) or Profile TCAM entries for either CFA (RX/TX) direction,
 744  * then frees the table scope ID.
 745  *
 746  * Returns success or failure code.
 747  */
 748 int tf_free_tbl_scope(struct tf *tfp,
 749                       struct tf_free_tbl_scope_parms *parms);
 750
 751
 752 /**
 753  * @page tcam TCAM Access
 754  *
 755  * @ref tf_alloc_tcam_entry
 756  *
 757  * @ref tf_set_tcam_entry
 758  *
 759  * @ref tf_get_tcam_entry
 760  *
 761  * @ref tf_free_tcam_entry
 762  */
 763
 764 /** tf_alloc_tcam_entry parameter definition
 765  */
 766 struct tf_alloc_tcam_entry_parms {
 767         /**
 768          * [in] receive or transmit direction
 769          */
 770         enum tf_dir dir;
 771         /**
 772          * [in] TCAM table type
 773          */
 774         enum tf_tcam_tbl_type tcam_tbl_type;
 775         /**
 776          * [in] Enable search for matching entry
 777          */
 778         uint8_t search_enable;
 779         /**
 780          * [in] Key data to match on (if search)
 781          */
 782         uint8_t *key;
 783         /**
 784          * [in] key size in bits (if search)
 785          */
 786         uint16_t key_sz_in_bits;
 787         /**
 788          * [in] Mask data to match on (if search)
 789          */
 790         uint8_t *mask;
 791         /**
 792          * [in] Priority of entry requested (definition TBD)
 793          */
 794         uint32_t priority;
 795         /**
 796          * [out] If search, set if matching entry found
 797          */
 798         uint8_t hit;
 799         /**
 800          * [out] Current refcnt after allocation
 801          */
 802         uint16_t ref_cnt;
 803         /**
 804          * [out] Idx allocated
 805          *
 806          */
 807         uint16_t idx;
 808 };
 809
 810 /** allocate TCAM entry
 811  *
 812  * Allocate a TCAM entry - one of these types:
 813  *
 814  * L2 Context
 815  * Profile TCAM
 816  * WC TCAM
 817  * VEB TCAM
 818  *
 819  * This function allocates a TCAM table record.  This function
 820  * will attempt to allocate a TCAM table entry from the session
 821  * owned TCAM entries or search a shadow copy of the TCAM table for a
 822  * matching entry if search is enabled.  Key, mask and result must match for
 823  * hit to be set.  Only TruFlow core data is accessed.
 824  * A hash table to entry mapping is maintained for search purposes.  If
 825  * search is not enabled, the first available free entry is returned based
 826  * on priority and alloc_cnt is set to 1.  If search is enabled and a matching
 827  * entry to entry_data is found, hit is set to TRUE and alloc_cnt is set to 1.
 828  * RefCnt is also returned.
 829  *
 830  * Also returns success or failure code.
 831  */
 832 int tf_alloc_tcam_entry(struct tf *tfp,
 833                         struct tf_alloc_tcam_entry_parms *parms);
 834
 835 /** tf_set_tcam_entry parameter definition
 836  */
 837 struct  tf_set_tcam_entry_parms {
 838         /**
 839          * [in] receive or transmit direction
 840          */
 841         enum tf_dir dir;
 842         /**
 843          * [in] TCAM table type
 844          */
 845         enum tf_tcam_tbl_type tcam_tbl_type;
 846         /**
 847          * [in] base index of the entry to program
 848          */
 849         uint16_t idx;
 850         /**
 851          * [in] struct containing key
 852          */
 853         uint8_t *key;
 854         /**
 855          * [in] struct containing mask fields
 856          */
 857         uint8_t *mask;
 858         /**
 859          * [in] key size in bits (if search)
 860          */
 861         uint16_t key_sz_in_bits;
 862         /**
 863          * [in] struct containing result
 864          */
 865         uint8_t *result;
 866         /**
 867          * [in] struct containing result size in bits
 868          */
 869         uint16_t result_sz_in_bits;
 870 };
 871
 872 /** set TCAM entry
 873  *
 874  * Program a TCAM table entry for a TruFlow session.
 875  *
 876  * If the entry has not been allocated, an error will be returned.
 877  *
 878  * Returns success or failure code.
 879  */
 880 int tf_set_tcam_entry(struct tf *tfp,
 881                       struct tf_set_tcam_entry_parms *parms);
 882
 883 /** tf_get_tcam_entry parameter definition
 884  */
 885 struct tf_get_tcam_entry_parms {
 886         /**
 887          * [in] receive or transmit direction
 888          */
 889         enum tf_dir dir;
 890         /**
 891          * [in] TCAM table type
 892          */
 893         enum tf_tcam_tbl_type  tcam_tbl_type;
 894         /**
 895          * [in] index of the entry to get
 896          */
 897         uint16_t idx;
 898         /**
 899          * [out] struct containing key
 900          */
 901         uint8_t *key;
 902         /**
 903          * [out] struct containing mask fields
 904          */
 905         uint8_t *mask;
 906         /**
 907          * [out] key size in bits
 908          */
 909         uint16_t key_sz_in_bits;
 910         /**
 911          * [out] struct containing result
 912          */
 913         uint8_t *result;
 914         /**
 915          * [out] struct containing result size in bits
 916          */
 917         uint16_t result_sz_in_bits;
 918 };
 919
 920 /*
 921  * get TCAM entry
 922  *
 923  * Program a TCAM table entry for a TruFlow session.
 924  *
 925  * If the entry has not been allocated, an error will be returned.
 926  *
 927  * Returns success or failure code.
 928  */
 929 int tf_get_tcam_entry(struct tf *tfp,
 930                       struct tf_get_tcam_entry_parms *parms);
 931
 932 /*
 933  * tf_free_tcam_entry parameter definition
 934  */
 935 struct tf_free_tcam_entry_parms {
 936         /**
 937          * [in] receive or transmit direction
 938          */
 939         enum tf_dir dir;
 940         /**
 941          * [in] TCAM table type
 942          */
 943         enum tf_tcam_tbl_type tcam_tbl_type;
 944         /**
 945          * [in] Index to free
 946          */
 947         uint16_t idx;
 948         /**
 949          * [out] reference count after free
 950          */
 951         uint16_t ref_cnt;
 952 };
 953
 954 /*
 955  * Free TCAM entry.
 956  *
 957  * Firmware checks to ensure the TCAM entries are owned by the TruFlow
 958  * session.  TCAM entry will be invalidated.  All-ones mask.
 959  * writes to hw.
 960  *
 961  * WCTCAM profile id of 0 must be used to invalidate an entry.
 962  *
 963  * Returns success or failure code.
 964  */
 965 int tf_free_tcam_entry(struct tf *tfp,
 966                        struct tf_free_tcam_entry_parms *parms);
 967
 968 /**
 969  * @page table Table Access
 970  *
 971  * @ref tf_alloc_tbl_entry
 972  *
 973  * @ref tf_free_tbl_entry
 974  *
 975  * @ref tf_set_tbl_entry
 976  *
 977  * @ref tf_get_tbl_entry
 978  */
 979
 980 /**
 981  * tf_alloc_tbl_entry parameter definition
 982  */
 983 struct tf_alloc_tbl_entry_parms {
 984         /**
 985          * [in] Receive or transmit direction
 986          */
 987         enum tf_dir dir;
 988         /**
 989          * [in] Type of the allocation
 990          */
 991         enum tf_tbl_type type;
 992         /**
 993          * [in] Table scope identifier (ignored unless TF_TBL_TYPE_EXT)
 994          */
 995         uint32_t tbl_scope_id;
 996         /**
 997          * [in] Enable search for matching entry. If the table type is
 998          * internal the shadow copy will be searched before
 999          * alloc. Session must be configured with shadow copy enabled.
1000          */
1001         uint8_t search_enable;
1002         /**
1003          * [in] Result data to search for (if search_enable)
1004          */
1005         uint8_t *result;
1006         /**
1007          * [in] Result data size in bytes (if search_enable)
1008          */
1009         uint16_t result_sz_in_bytes;
1010         /**
1011          * [out] If search_enable, set if matching entry found
1012          */
1013         uint8_t hit;
1014         /**
1015          * [out] Current ref count after allocation (if search_enable)
1016          */
1017         uint16_t ref_cnt;
1018         /**
1019          * [out] Idx of allocated entry or found entry (if search_enable)
1020          */
1021         uint32_t idx;
1022 };
1023
1024 /**
1025  * allocate index table entries
1026  *
1027  * Internal types:
1028  *
1029  * Allocate an on chip index table entry or search for a matching
1030  * entry of the indicated type for this TruFlow session.
1031  *
1032  * Allocates an index table record. This function will attempt to
1033  * allocate an entry or search an index table for a matching entry if
1034  * search is enabled (only the shadow copy of the table is accessed).
1035  *
1036  * If search is not enabled, the first available free entry is
1037  * returned. If search is enabled and a matching entry to entry_data
1038  * is found hit is set to TRUE and success is returned.
1039  *
1040  * External types:
1041  *
1042  * These are used to allocate inlined action record memory.
1043  *
1044  * Allocates an external index table action record.
1045  *
1046  * NOTE:
1047  * Implementation of the internals of this function will be a stack with push
1048  * and pop.
1049  *
1050  * Returns success or failure code.
1051  */
1052 int tf_alloc_tbl_entry(struct tf *tfp,
1053                        struct tf_alloc_tbl_entry_parms *parms);
1054
1055 /**
1056  * tf_free_tbl_entry parameter definition
1057  */
1058 struct tf_free_tbl_entry_parms {
1059         /**
1060          * [in] Receive or transmit direction
1061          */
1062         enum tf_dir dir;
1063         /**
1064          * [in] Type of the allocation type
1065          */
1066         enum tf_tbl_type type;
1067         /**
1068          * [in] Table scope identifier (ignored unless TF_TBL_TYPE_EXT)
1069          */
1070         uint32_t tbl_scope_id;
1071         /**
1072          * [in] Index to free
1073          */
1074         uint32_t idx;
1075         /**
1076          * [out] Reference count after free, only valid if session has been
1077          * created with shadow_copy.
1078          */
1079         uint16_t ref_cnt;
1080 };
1081
1082 /**
1083  * free index table entry
1084  *
1085  * Used to free a previously allocated table entry.
1086  *
1087  * Internal types:
1088  *
1089  * If session has shadow_copy enabled the shadow DB is searched and if
1090  * found the element ref_cnt is decremented. If ref_cnt goes to
1091  * zero then the element is returned to the session pool.
1092  *
1093  * If the session does not have a shadow DB the element is free'ed and
1094  * given back to the session pool.
1095  *
1096  * External types:
1097  *
1098  * Free's an external index table action record.
1099  *
1100  * NOTE:
1101  * Implementation of the internals of this function will be a stack with push
1102  * and pop.
1103  *
1104  * Returns success or failure code.
1105  */
1106 int tf_free_tbl_entry(struct tf *tfp,
1107                       struct tf_free_tbl_entry_parms *parms);
1108
1109 /**
1110  * tf_set_tbl_entry parameter definition
1111  */
1112 struct tf_set_tbl_entry_parms {
1113         /**
1114          * [in] Table scope identifier
1115          */
1116         uint32_t tbl_scope_id;
1117         /**
1118          * [in] Receive or transmit direction
1119          */
1120         enum tf_dir dir;
1121         /**
1122          * [in] Type of object to set
1123          */
1124         enum tf_tbl_type type;
1125         /**
1126          * [in] Entry data
1127          */
1128         uint8_t *data;
1129         /**
1130          * [in] Entry size
1131          */
1132         uint16_t data_sz_in_bytes;
1133         /**
1134          * [in] Entry index to write to
1135          */
1136         uint32_t idx;
1137 };
1138
1139 /**
1140  * set index table entry
1141  *
1142  * Used to insert an application programmed index table entry into a
1143  * previous allocated table location.  A shadow copy of the table
1144  * is maintained (if enabled) (only for internal objects)
1145  *
1146  * Returns success or failure code.
1147  */
1148 int tf_set_tbl_entry(struct tf *tfp,
1149                      struct tf_set_tbl_entry_parms *parms);
1150
1151 /**
1152  * tf_get_tbl_entry parameter definition
1153  */
1154 struct tf_get_tbl_entry_parms {
1155         /**
1156          * [in] Receive or transmit direction
1157          */
1158         enum tf_dir dir;
1159         /**
1160          * [in] Type of object to get
1161          */
1162         enum tf_tbl_type type;
1163         /**
1164          * [out] Entry data
1165          */
1166         uint8_t *data;
1167         /**
1168          * [out] Entry size
1169          */
1170         uint16_t data_sz_in_bytes;
1171         /**
1172          * [in] Entry index to read
1173          */
1174         uint32_t idx;
1175 };
1176
1177 /**
1178  * get index table entry
1179  *
1180  * Used to retrieve a previous set index table entry.
1181  *
1182  * Reads and compares with the shadow table copy (if enabled) (only
1183  * for internal objects).
1184  *
1185  * Returns success or failure code. Failure will be returned if the
1186  * provided data buffer is too small for the data type requested.
1187  */
1188 int tf_get_tbl_entry(struct tf *tfp,
1189                      struct tf_get_tbl_entry_parms *parms);
1190
1191 /**
1192  * @page exact_match Exact Match Table
1193  *
1194  * @ref tf_insert_em_entry
1195  *
1196  * @ref tf_delete_em_entry
1197  *
1198  * @ref tf_search_em_entry
1199  *
1200  */
1201 /**
1202  * tf_insert_em_entry parameter definition
1203  */
1204 struct tf_insert_em_entry_parms {
1205         /**
1206          * [in] receive or transmit direction
1207          */
1208         enum tf_dir dir;
1209         /**
1210          * [in] internal or external
1211          */
1212         enum tf_mem mem;
1213         /**
1214          * [in] ID of table scope to use (external only)
1215          */
1216         uint32_t tbl_scope_id;
1217         /**
1218          * [in] ID of table interface to use (Brd4 only)
1219          */
1220         uint32_t tbl_if_id;
1221         /**
1222          * [in] ptr to structure containing key fields
1223          */
1224         uint8_t *key;
1225         /**
1226          * [in] key bit length
1227          */
1228         uint16_t key_sz_in_bits;
1229         /**
1230          * [in] ptr to structure containing result field
1231          */
1232         uint8_t *em_record;
1233         /**
1234          * [out] result size in bits
1235          */
1236         uint16_t em_record_sz_in_bits;
1237         /**
1238          * [in] duplicate check flag
1239          */
1240         uint8_t dup_check;
1241         /**
1242          * [out] Flow handle value for the inserted entry.  This is encoded
1243          * as the entries[4]:bucket[2]:hashId[1]:hash[14]
1244          */
1245         uint64_t flow_handle;
1246         /**
1247          * [out] Flow id is returned as null (internal)
1248          * Flow id is the GFID value for the inserted entry (external)
1249          * This is the value written to the BD and useful information for mark.
1250          */
1251         uint64_t flow_id;
1252 };
1253 /**
1254  * tf_delete_em_entry parameter definition
1255  */
1256 struct tf_delete_em_entry_parms {
1257         /**
1258          * [in] receive or transmit direction
1259          */
1260         enum tf_dir dir;
1261         /**
1262          * [in] internal or external
1263          */
1264         enum tf_mem mem;
1265         /**
1266          * [in] ID of table scope to use (external only)
1267          */
1268         uint32_t tbl_scope_id;
1269         /**
1270          * [in] ID of table interface to use (Brd4 only)
1271          */
1272         uint32_t tbl_if_id;
1273         /**
1274          * [in] epoch group IDs of entry to delete
1275          * 2 element array with 2 ids. (Brd4 only)
1276          */
1277         uint16_t *epochs;
1278         /**
1279          * [out] The index of the entry
1280          */
1281         uint16_t index;
1282         /**
1283          * [in] structure containing flow delete handle information
1284          */
1285         uint64_t flow_handle;
1286 };
1287 /**
1288  * tf_search_em_entry parameter definition
1289  */
1290 struct tf_search_em_entry_parms {
1291         /**
1292          * [in] receive or transmit direction
1293          */
1294         enum tf_dir dir;
1295         /**
1296          * [in] internal or external
1297          */
1298         enum tf_mem mem;
1299         /**
1300          * [in] ID of table scope to use (external only)
1301          */
1302         uint32_t tbl_scope_id;
1303         /**
1304          * [in] ID of table interface to use (Brd4 only)
1305          */
1306         uint32_t tbl_if_id;
1307         /**
1308          * [in] ptr to structure containing key fields
1309          */
1310         uint8_t *key;
1311         /**
1312          * [in] key bit length
1313          */
1314         uint16_t key_sz_in_bits;
1315         /**
1316          * [in/out] ptr to structure containing EM record fields
1317          */
1318         uint8_t *em_record;
1319         /**
1320          * [out] result size in bits
1321          */
1322         uint16_t em_record_sz_in_bits;
1323         /**
1324          * [in] epoch group IDs of entry to lookup
1325          * 2 element array with 2 ids. (Brd4 only)
1326          */
1327         uint16_t *epochs;
1328         /**
1329          * [in] ptr to structure containing flow delete handle
1330          */
1331         uint64_t flow_handle;
1332 };
1333
1334 /**
1335  * insert em hash entry in internal table memory
1336  *
1337  * Internal:
1338  *
1339  * This API inserts an exact match entry into internal EM table memory
1340  * of the specified direction.
1341  *
1342  * Note: The EM record is managed within the TruFlow core and not the
1343  * application.
1344  *
1345  * Shadow copy of internal record table an association with hash and 1,2, or 4
1346  * associated buckets
1347  *
1348  * External:
1349  * This API inserts an exact match entry into DRAM EM table memory of the
1350  * specified direction and table scope.
1351  *
1352  * When inserting an entry into an exact match table, the TruFlow library may
1353  * need to allocate a dynamic bucket for the entry (Brd4 only).
1354  *
1355  * The insertion of duplicate entries in an EM table is not permitted.  If a
1356  * TruFlow application can guarantee that it will never insert duplicates, it
1357  * can disable duplicate checking by passing a zero value in the  dup_check
1358  * parameter to this API.  This will optimize performance. Otherwise, the
1359  * TruFlow library will enforce protection against inserting duplicate entries.
1360  *
1361  * Flow handle is defined in this document:
1362  *
1363  * https://docs.google.com
1364  * /document/d/1NESu7RpTN3jwxbokaPfYORQyChYRmJgs40wMIRe8_-Q/edit
1365  *
1366  * Returns success or busy code.
1367  *
1368  */
1369 int tf_insert_em_entry(struct tf *tfp,
1370                        struct tf_insert_em_entry_parms *parms);
1371
1372 /**
1373  * delete em hash entry table memory
1374  *
1375  * Internal:
1376  *
1377  * This API deletes an exact match entry from internal EM table memory of the
1378  * specified direction. If a valid flow ptr is passed in then that takes
1379  * precedence over the pointer to the complete key passed in.
1380  *
1381  *
1382  * External:
1383  *
1384  * This API deletes an exact match entry from EM table memory of the specified
1385  * direction and table scope. If a valid flow handle is passed in then that
1386  * takes precedence over the pointer to the complete key passed in.
1387  *
1388  * The TruFlow library may release a dynamic bucket when an entry is deleted.
1389  *
1390  *
1391  * Returns success or not found code
1392  *
1393  *
1394  */
1395 int tf_delete_em_entry(struct tf *tfp,
1396                        struct tf_delete_em_entry_parms *parms);
1397
1398 /**
1399  * search em hash entry table memory
1400  *
1401  * Internal:
1402
1403  * This API looks up an EM entry in table memory with the specified EM
1404  * key or flow (flow takes precedence) and direction.
1405  *
1406  * The status will be one of: success or entry not found.  If the lookup
1407  * succeeds, a pointer to the matching entry and the result record associated
1408  * with the matching entry will be provided.
1409  *
1410  * If flow_handle is set, search shadow copy.
1411  *
1412  * Otherwise, query the fw with key to get result.
1413  *
1414  * External:
1415  *
1416  * This API looks up an EM entry in table memory with the specified EM
1417  * key or flow_handle (flow takes precedence), direction and table scope.
1418  *
1419  * The status will be one of: success or entry not found.  If the lookup
1420  * succeeds, a pointer to the matching entry and the result record associated
1421  * with the matching entry will be provided.
1422  *
1423  * Returns success or not found code
1424  *
1425  */
1426 int tf_search_em_entry(struct tf *tfp,
1427                        struct tf_search_em_entry_parms *parms);
1428 #endif /* _TF_CORE_H_ */