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 identifier_cnt[TF_IDENT_TYPE_MAX][TF_DIR_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 int tf_open_session_new(struct tf *tfp,
 484                         struct tf_open_session_parms *parms);
 485
 486 struct tf_attach_session_parms {
 487         /** [in] ctrl_chan_name
 488          *
 489          * String containing name of control channel interface to be
 490          * used for this session to communicate with firmware.
 491          *
 492          * The ctrl_chan_name can be looked up by using
 493          * rte_eth_dev_get_name_by_port() within the ULP.
 494          *
 495          * ctrl_chan_name will be used as part of a name for any
 496          * shared memory allocation.
 497          */
 498         char ctrl_chan_name[TF_SESSION_NAME_MAX];
 499
 500         /** [in] attach_chan_name
 501          *
 502          * String containing name of attach channel interface to be
 503          * used for this session.
 504          *
 505          * The attach_chan_name must be given to a 2nd process after
 506          * the primary process has been created. This is the
 507          * ctrl_chan_name of the primary process and is used to find
 508          * the shared memory for the session that the attach is going
 509          * to use.
 510          */
 511         char attach_chan_name[TF_SESSION_NAME_MAX];
 512
 513         /** [in] session_id
 514          *
 515          * Session_id is unique per session. For Attach the session_id
 516          * should be the session_id that was returned on the first
 517          * open.
 518          *
 519          * Session_id is composed of domain, bus, device and
 520          * fw_session_id. The construction is done by parsing the
 521          * ctrl_chan_name together with allocation of a fw_session_id
 522          * during tf_open_session().
 523          *
 524          * A reference count will be incremented on attach. A session
 525          * is first fully closed when reference count is zero by
 526          * calling tf_close_session().
 527          */
 528         union tf_session_id session_id;
 529 };
 530
 531 /**
 532  * Attaches to an existing session. Used when more than one PF wants
 533  * to share a single session. In that case all TruFlow management
 534  * traffic will be sent to the TruFlow firmware using the 'PF' that
 535  * did the attach not the session ctrl channel.
 536  *
 537  * Attach will increment a ref count as to manage the shared session data.
 538  *
 539  * [in] tfp, pointer to TF handle
 540  * [in] parms, pointer to attach parameters
 541  *
 542  * Returns
 543  *   - (0) if successful.
 544  *   - (-EINVAL) on failure.
 545  */
 546 int tf_attach_session(struct tf *tfp,
 547                       struct tf_attach_session_parms *parms);
 548 int tf_attach_session_new(struct tf *tfp,
 549                           struct tf_attach_session_parms *parms);
 550
 551 /**
 552  * Closes an existing session. Cleans up all hardware and firmware
 553  * state associated with the TruFlow application session when the last
 554  * PF associated with the session results in refcount to be zero.
 555  *
 556  * Returns success or failure code.
 557  */
 558 int tf_close_session(struct tf *tfp);
 559 int tf_close_session_new(struct tf *tfp);
 560
 561 /**
 562  * @page  ident Identity Management
 563  *
 564  * @ref tf_alloc_identifier
 565  *
 566  * @ref tf_free_identifier
 567  */
 568 /** tf_alloc_identifier parameter definition
 569  */
 570 struct tf_alloc_identifier_parms {
 571         /**
 572          * [in]  receive or transmit direction
 573          */
 574         enum tf_dir dir;
 575         /**
 576          * [in] Identifier type
 577          */
 578         enum tf_identifier_type ident_type;
 579         /**
 580          * [out] Identifier allocated
 581          */
 582         uint16_t id;
 583 };
 584
 585 /** tf_free_identifier parameter definition
 586  */
 587 struct tf_free_identifier_parms {
 588         /**
 589          * [in]  receive or transmit direction
 590          */
 591         enum tf_dir dir;
 592         /**
 593          * [in] Identifier type
 594          */
 595         enum tf_identifier_type ident_type;
 596         /**
 597          * [in] ID to free
 598          */
 599         uint16_t id;
 600 };
 601
 602 /** allocate identifier resource
 603  *
 604  * TruFlow core will allocate a free id from the per identifier resource type
 605  * pool reserved for the session during tf_open().  No firmware is involved.
 606  *
 607  * Returns success or failure code.
 608  */
 609 int tf_alloc_identifier(struct tf *tfp,
 610                         struct tf_alloc_identifier_parms *parms);
 611 int tf_alloc_identifier_new(struct tf *tfp,
 612                             struct tf_alloc_identifier_parms *parms);
 613
 614 /** free identifier resource
 615  *
 616  * TruFlow core will return an id back to the per identifier resource type pool
 617  * reserved for the session.  No firmware is involved.  During tf_close, the
 618  * complete pool is returned to the firmware.
 619  *
 620  * Returns success or failure code.
 621  */
 622 int tf_free_identifier(struct tf *tfp,
 623                        struct tf_free_identifier_parms *parms);
 624 int tf_free_identifier_new(struct tf *tfp,
 625                            struct tf_free_identifier_parms *parms);
 626
 627 /**
 628  * @page dram_table DRAM Table Scope Interface
 629  *
 630  * @ref tf_alloc_tbl_scope
 631  *
 632  * @ref tf_free_tbl_scope
 633  *
 634  * If we allocate the EEM memory from the core, we need to store it in
 635  * the shared session data structure to make sure it can be freed later.
 636  * (for example if the PF goes away)
 637  *
 638  * Current thought is that memory is allocated within core.
 639  */
 640
 641
 642 /** tf_alloc_tbl_scope_parms definition
 643  */
 644 struct tf_alloc_tbl_scope_parms {
 645         /**
 646          * [in] All Maximum key size required.
 647          */
 648         uint16_t rx_max_key_sz_in_bits;
 649         /**
 650          * [in] Maximum Action size required (includes inlined items)
 651          */
 652         uint16_t rx_max_action_entry_sz_in_bits;
 653         /**
 654          * [in] Memory size in Megabytes
 655          * Total memory size allocated by user to be divided
 656          * up for actions, hash, counters.  Only inline external actions.
 657          * Use this variable or the number of flows, do not set both.
 658          */
 659         uint32_t rx_mem_size_in_mb;
 660         /**
 661          * [in] Number of flows * 1000. If set, rx_mem_size_in_mb must equal 0.
 662          */
 663         uint32_t rx_num_flows_in_k;
 664         /**
 665          * [in] Brd4 only receive table access interface id
 666          */
 667         uint32_t rx_tbl_if_id;
 668         /**
 669          * [in] All Maximum key size required.
 670          */
 671         uint16_t tx_max_key_sz_in_bits;
 672         /**
 673          * [in] Maximum Action size required (includes inlined items)
 674          */
 675         uint16_t tx_max_action_entry_sz_in_bits;
 676         /**
 677          * [in] Memory size in Megabytes
 678          * Total memory size allocated by user to be divided
 679          * up for actions, hash, counters.  Only inline external actions.
 680          */
 681         uint32_t tx_mem_size_in_mb;
 682         /**
 683          * [in] Number of flows * 1000
 684          */
 685         uint32_t tx_num_flows_in_k;
 686         /**
 687          * [in] Brd4 only receive table access interface id
 688          */
 689         uint32_t tx_tbl_if_id;
 690         /**
 691          * [in] Flush pending HW cached flows every 1/10th of value
 692          * set in seconds, both idle and active flows are flushed
 693          * from the HW cache. If set to 0, this feature will be disabled.
 694          */
 695         uint8_t hw_flow_cache_flush_timer;
 696         /**
 697          * [out] table scope identifier
 698          */
 699         uint32_t tbl_scope_id;
 700 };
 701
 702 struct tf_free_tbl_scope_parms {
 703         /**
 704          * [in] table scope identifier
 705          */
 706         uint32_t tbl_scope_id;
 707 };
 708
 709 /**
 710  * allocate a table scope
 711  *
 712  * On Brd4 Firmware will allocate a scope ID.  On other devices, the scope
 713  * is a software construct to identify an EEM table.  This function will
 714  * divide the hash memory/buckets and records according to the device
 715  * device constraints based upon calculations using either the number of flows
 716  * requested or the size of memory indicated.  Other parameters passed in
 717  * determine the configuration (maximum key size, maximum external action record
 718  * size.
 719  *
 720  * This API will allocate the table region in
 721  * DRAM, program the PTU page table entries, and program the number of static
 722  * buckets (if Brd4) in the RX and TX CFAs.  Buckets are assumed to start at
 723  * 0 in the EM memory for the scope.  Upon successful completion of this API,
 724  * hash tables are fully initialized and ready for entries to be inserted.
 725  *
 726  * A single API is used to allocate a common table scope identifier in both
 727  * receive and transmit CFA. The scope identifier is common due to nature of
 728  * connection tracking sending notifications between RX and TX direction.
 729  *
 730  * The receive and transmit table access identifiers specify which rings will
 731  * be used to initialize table DRAM.  The application must ensure mutual
 732  * exclusivity of ring usage for table scope allocation and any table update
 733  * operations.
 734  *
 735  * The hash table buckets, EM keys, and EM lookup results are stored in the
 736  * memory allocated based on the rx_em_hash_mb/tx_em_hash_mb parameters.  The
 737  * hash table buckets are stored at the beginning of that memory.
 738  *
 739  * NOTE:  No EM internal setup is done here. On chip EM records are managed
 740  * internally by TruFlow core.
 741  *
 742  * Returns success or failure code.
 743  */
 744 int tf_alloc_tbl_scope(struct tf *tfp,
 745                        struct tf_alloc_tbl_scope_parms *parms);
 746
 747
 748 /**
 749  * free a table scope
 750  *
 751  * Firmware checks that the table scope ID is owned by the TruFlow
 752  * session, verifies that no references to this table scope remains
 753  * (Brd4 ILT) or Profile TCAM entries for either CFA (RX/TX) direction,
 754  * then frees the table scope ID.
 755  *
 756  * Returns success or failure code.
 757  */
 758 int tf_free_tbl_scope(struct tf *tfp,
 759                       struct tf_free_tbl_scope_parms *parms);
 760
 761
 762 /**
 763  * @page tcam TCAM Access
 764  *
 765  * @ref tf_alloc_tcam_entry
 766  *
 767  * @ref tf_set_tcam_entry
 768  *
 769  * @ref tf_get_tcam_entry
 770  *
 771  * @ref tf_free_tcam_entry
 772  */
 773
 774 /** tf_alloc_tcam_entry parameter definition
 775  */
 776 struct tf_alloc_tcam_entry_parms {
 777         /**
 778          * [in] receive or transmit direction
 779          */
 780         enum tf_dir dir;
 781         /**
 782          * [in] TCAM table type
 783          */
 784         enum tf_tcam_tbl_type tcam_tbl_type;
 785         /**
 786          * [in] Enable search for matching entry
 787          */
 788         uint8_t search_enable;
 789         /**
 790          * [in] Key data to match on (if search)
 791          */
 792         uint8_t *key;
 793         /**
 794          * [in] key size in bits (if search)
 795          */
 796         uint16_t key_sz_in_bits;
 797         /**
 798          * [in] Mask data to match on (if search)
 799          */
 800         uint8_t *mask;
 801         /**
 802          * [in] Priority of entry requested (definition TBD)
 803          */
 804         uint32_t priority;
 805         /**
 806          * [out] If search, set if matching entry found
 807          */
 808         uint8_t hit;
 809         /**
 810          * [out] Current refcnt after allocation
 811          */
 812         uint16_t ref_cnt;
 813         /**
 814          * [out] Idx allocated
 815          *
 816          */
 817         uint16_t idx;
 818 };
 819
 820 /** allocate TCAM entry
 821  *
 822  * Allocate a TCAM entry - one of these types:
 823  *
 824  * L2 Context
 825  * Profile TCAM
 826  * WC TCAM
 827  * VEB TCAM
 828  *
 829  * This function allocates a TCAM table record.  This function
 830  * will attempt to allocate a TCAM table entry from the session
 831  * owned TCAM entries or search a shadow copy of the TCAM table for a
 832  * matching entry if search is enabled.  Key, mask and result must match for
 833  * hit to be set.  Only TruFlow core data is accessed.
 834  * A hash table to entry mapping is maintained for search purposes.  If
 835  * search is not enabled, the first available free entry is returned based
 836  * on priority and alloc_cnt is set to 1.  If search is enabled and a matching
 837  * entry to entry_data is found, hit is set to TRUE and alloc_cnt is set to 1.
 838  * RefCnt is also returned.
 839  *
 840  * Also returns success or failure code.
 841  */
 842 int tf_alloc_tcam_entry(struct tf *tfp,
 843                         struct tf_alloc_tcam_entry_parms *parms);
 844
 845 /** tf_set_tcam_entry parameter definition
 846  */
 847 struct  tf_set_tcam_entry_parms {
 848         /**
 849          * [in] receive or transmit direction
 850          */
 851         enum tf_dir dir;
 852         /**
 853          * [in] TCAM table type
 854          */
 855         enum tf_tcam_tbl_type tcam_tbl_type;
 856         /**
 857          * [in] base index of the entry to program
 858          */
 859         uint16_t idx;
 860         /**
 861          * [in] struct containing key
 862          */
 863         uint8_t *key;
 864         /**
 865          * [in] struct containing mask fields
 866          */
 867         uint8_t *mask;
 868         /**
 869          * [in] key size in bits (if search)
 870          */
 871         uint16_t key_sz_in_bits;
 872         /**
 873          * [in] struct containing result
 874          */
 875         uint8_t *result;
 876         /**
 877          * [in] struct containing result size in bits
 878          */
 879         uint16_t result_sz_in_bits;
 880 };
 881
 882 /** set TCAM entry
 883  *
 884  * Program a TCAM table entry for a TruFlow session.
 885  *
 886  * If the entry has not been allocated, an error will be returned.
 887  *
 888  * Returns success or failure code.
 889  */
 890 int tf_set_tcam_entry(struct tf *tfp,
 891                       struct tf_set_tcam_entry_parms *parms);
 892
 893 /** tf_get_tcam_entry parameter definition
 894  */
 895 struct tf_get_tcam_entry_parms {
 896         /**
 897          * [in] receive or transmit direction
 898          */
 899         enum tf_dir dir;
 900         /**
 901          * [in] TCAM table type
 902          */
 903         enum tf_tcam_tbl_type  tcam_tbl_type;
 904         /**
 905          * [in] index of the entry to get
 906          */
 907         uint16_t idx;
 908         /**
 909          * [out] struct containing key
 910          */
 911         uint8_t *key;
 912         /**
 913          * [out] struct containing mask fields
 914          */
 915         uint8_t *mask;
 916         /**
 917          * [out] key size in bits
 918          */
 919         uint16_t key_sz_in_bits;
 920         /**
 921          * [out] struct containing result
 922          */
 923         uint8_t *result;
 924         /**
 925          * [out] struct containing result size in bits
 926          */
 927         uint16_t result_sz_in_bits;
 928 };
 929
 930 /*
 931  * get TCAM entry
 932  *
 933  * Program a TCAM table entry for a TruFlow session.
 934  *
 935  * If the entry has not been allocated, an error will be returned.
 936  *
 937  * Returns success or failure code.
 938  */
 939 int tf_get_tcam_entry(struct tf *tfp,
 940                       struct tf_get_tcam_entry_parms *parms);
 941
 942 /*
 943  * tf_free_tcam_entry parameter definition
 944  */
 945 struct tf_free_tcam_entry_parms {
 946         /**
 947          * [in] receive or transmit direction
 948          */
 949         enum tf_dir dir;
 950         /**
 951          * [in] TCAM table type
 952          */
 953         enum tf_tcam_tbl_type tcam_tbl_type;
 954         /**
 955          * [in] Index to free
 956          */
 957         uint16_t idx;
 958         /**
 959          * [out] reference count after free
 960          */
 961         uint16_t ref_cnt;
 962 };
 963
 964 /*
 965  * Free TCAM entry.
 966  *
 967  * Firmware checks to ensure the TCAM entries are owned by the TruFlow
 968  * session.  TCAM entry will be invalidated.  All-ones mask.
 969  * writes to hw.
 970  *
 971  * WCTCAM profile id of 0 must be used to invalidate an entry.
 972  *
 973  * Returns success or failure code.
 974  */
 975 int tf_free_tcam_entry(struct tf *tfp,
 976                        struct tf_free_tcam_entry_parms *parms);
 977
 978 /**
 979  * @page table Table Access
 980  *
 981  * @ref tf_alloc_tbl_entry
 982  *
 983  * @ref tf_free_tbl_entry
 984  *
 985  * @ref tf_set_tbl_entry
 986  *
 987  * @ref tf_get_tbl_entry
 988  */
 989
 990 /**
 991  * tf_alloc_tbl_entry parameter definition
 992  */
 993 struct tf_alloc_tbl_entry_parms {
 994         /**
 995          * [in] Receive or transmit direction
 996          */
 997         enum tf_dir dir;
 998         /**
 999          * [in] Type of the allocation
1000          */
1001         enum tf_tbl_type type;
1002         /**
1003          * [in] Table scope identifier (ignored unless TF_TBL_TYPE_EXT)
1004          */
1005         uint32_t tbl_scope_id;
1006         /**
1007          * [in] Enable search for matching entry. If the table type is
1008          * internal the shadow copy will be searched before
1009          * alloc. Session must be configured with shadow copy enabled.
1010          */
1011         uint8_t search_enable;
1012         /**
1013          * [in] Result data to search for (if search_enable)
1014          */
1015         uint8_t *result;
1016         /**
1017          * [in] Result data size in bytes (if search_enable)
1018          */
1019         uint16_t result_sz_in_bytes;
1020         /**
1021          * [out] If search_enable, set if matching entry found
1022          */
1023         uint8_t hit;
1024         /**
1025          * [out] Current ref count after allocation (if search_enable)
1026          */
1027         uint16_t ref_cnt;
1028         /**
1029          * [out] Idx of allocated entry or found entry (if search_enable)
1030          */
1031         uint32_t idx;
1032 };
1033
1034 /**
1035  * allocate index table entries
1036  *
1037  * Internal types:
1038  *
1039  * Allocate an on chip index table entry or search for a matching
1040  * entry of the indicated type for this TruFlow session.
1041  *
1042  * Allocates an index table record. This function will attempt to
1043  * allocate an entry or search an index table for a matching entry if
1044  * search is enabled (only the shadow copy of the table is accessed).
1045  *
1046  * If search is not enabled, the first available free entry is
1047  * returned. If search is enabled and a matching entry to entry_data
1048  * is found hit is set to TRUE and success is returned.
1049  *
1050  * External types:
1051  *
1052  * These are used to allocate inlined action record memory.
1053  *
1054  * Allocates an external index table action record.
1055  *
1056  * NOTE:
1057  * Implementation of the internals of this function will be a stack with push
1058  * and pop.
1059  *
1060  * Returns success or failure code.
1061  */
1062 int tf_alloc_tbl_entry(struct tf *tfp,
1063                        struct tf_alloc_tbl_entry_parms *parms);
1064
1065 /**
1066  * tf_free_tbl_entry parameter definition
1067  */
1068 struct tf_free_tbl_entry_parms {
1069         /**
1070          * [in] Receive or transmit direction
1071          */
1072         enum tf_dir dir;
1073         /**
1074          * [in] Type of the allocation type
1075          */
1076         enum tf_tbl_type type;
1077         /**
1078          * [in] Table scope identifier (ignored unless TF_TBL_TYPE_EXT)
1079          */
1080         uint32_t tbl_scope_id;
1081         /**
1082          * [in] Index to free
1083          */
1084         uint32_t idx;
1085         /**
1086          * [out] Reference count after free, only valid if session has been
1087          * created with shadow_copy.
1088          */
1089         uint16_t ref_cnt;
1090 };
1091
1092 /**
1093  * free index table entry
1094  *
1095  * Used to free a previously allocated table entry.
1096  *
1097  * Internal types:
1098  *
1099  * If session has shadow_copy enabled the shadow DB is searched and if
1100  * found the element ref_cnt is decremented. If ref_cnt goes to
1101  * zero then the element is returned to the session pool.
1102  *
1103  * If the session does not have a shadow DB the element is free'ed and
1104  * given back to the session pool.
1105  *
1106  * External types:
1107  *
1108  * Free's an external index table action record.
1109  *
1110  * NOTE:
1111  * Implementation of the internals of this function will be a stack with push
1112  * and pop.
1113  *
1114  * Returns success or failure code.
1115  */
1116 int tf_free_tbl_entry(struct tf *tfp,
1117                       struct tf_free_tbl_entry_parms *parms);
1118
1119 /**
1120  * tf_set_tbl_entry parameter definition
1121  */
1122 struct tf_set_tbl_entry_parms {
1123         /**
1124          * [in] Table scope identifier
1125          */
1126         uint32_t tbl_scope_id;
1127         /**
1128          * [in] Receive or transmit direction
1129          */
1130         enum tf_dir dir;
1131         /**
1132          * [in] Type of object to set
1133          */
1134         enum tf_tbl_type type;
1135         /**
1136          * [in] Entry data
1137          */
1138         uint8_t *data;
1139         /**
1140          * [in] Entry size
1141          */
1142         uint16_t data_sz_in_bytes;
1143         /**
1144          * [in] Entry index to write to
1145          */
1146         uint32_t idx;
1147 };
1148
1149 /**
1150  * set index table entry
1151  *
1152  * Used to insert an application programmed index table entry into a
1153  * previous allocated table location.  A shadow copy of the table
1154  * is maintained (if enabled) (only for internal objects)
1155  *
1156  * Returns success or failure code.
1157  */
1158 int tf_set_tbl_entry(struct tf *tfp,
1159                      struct tf_set_tbl_entry_parms *parms);
1160
1161 /**
1162  * tf_get_tbl_entry parameter definition
1163  */
1164 struct tf_get_tbl_entry_parms {
1165         /**
1166          * [in] Receive or transmit direction
1167          */
1168         enum tf_dir dir;
1169         /**
1170          * [in] Type of object to get
1171          */
1172         enum tf_tbl_type type;
1173         /**
1174          * [out] Entry data
1175          */
1176         uint8_t *data;
1177         /**
1178          * [in] Entry size
1179          */
1180         uint16_t data_sz_in_bytes;
1181         /**
1182          * [in] Entry index to read
1183          */
1184         uint32_t idx;
1185 };
1186
1187 /**
1188  * get index table entry
1189  *
1190  * Used to retrieve a previous set index table entry.
1191  *
1192  * Reads and compares with the shadow table copy (if enabled) (only
1193  * for internal objects).
1194  *
1195  * Returns success or failure code. Failure will be returned if the
1196  * provided data buffer is too small for the data type requested.
1197  */
1198 int tf_get_tbl_entry(struct tf *tfp,
1199                      struct tf_get_tbl_entry_parms *parms);
1200
1201 /**
1202  * tf_get_bulk_tbl_entry parameter definition
1203  */
1204 struct tf_get_bulk_tbl_entry_parms {
1205         /**
1206          * [in] Receive or transmit direction
1207          */
1208         enum tf_dir dir;
1209         /**
1210          * [in] Type of object to get
1211          */
1212         enum tf_tbl_type type;
1213         /**
1214          * [in] Clear hardware entries on reads only
1215          * supported for TF_TBL_TYPE_ACT_STATS_64
1216          */
1217         bool clear_on_read;
1218         /**
1219          * [in] Starting index to read from
1220          */
1221         uint32_t starting_idx;
1222         /**
1223          * [in] Number of sequential entries
1224          */
1225         uint16_t num_entries;
1226         /**
1227          * [in] Size of the single entry
1228          */
1229         uint16_t entry_sz_in_bytes;
1230         /**
1231          * [out] Host physical address, where the data
1232          * will be copied to by the firmware.
1233          * Use tfp_calloc() API and mem_pa
1234          * variable of the tfp_calloc_parms
1235          * structure for the physical address.
1236          */
1237         uint64_t physical_mem_addr;
1238 };
1239
1240 /**
1241  * Bulk get index table entry
1242  *
1243  * Used to retrieve a previous set index table entry.
1244  *
1245  * Reads and compares with the shadow table copy (if enabled) (only
1246  * for internal objects).
1247  *
1248  * Returns success or failure code. Failure will be returned if the
1249  * provided data buffer is too small for the data type requested.
1250  */
1251 int tf_get_bulk_tbl_entry(struct tf *tfp,
1252                      struct tf_get_bulk_tbl_entry_parms *parms);
1253
1254 /**
1255  * @page exact_match Exact Match Table
1256  *
1257  * @ref tf_insert_em_entry
1258  *
1259  * @ref tf_delete_em_entry
1260  *
1261  * @ref tf_search_em_entry
1262  *
1263  */
1264 /**
1265  * tf_insert_em_entry parameter definition
1266  */
1267 struct tf_insert_em_entry_parms {
1268         /**
1269          * [in] receive or transmit direction
1270          */
1271         enum tf_dir dir;
1272         /**
1273          * [in] internal or external
1274          */
1275         enum tf_mem mem;
1276         /**
1277          * [in] ID of table scope to use (external only)
1278          */
1279         uint32_t tbl_scope_id;
1280         /**
1281          * [in] ID of table interface to use (Brd4 only)
1282          */
1283         uint32_t tbl_if_id;
1284         /**
1285          * [in] ptr to structure containing key fields
1286          */
1287         uint8_t *key;
1288         /**
1289          * [in] key bit length
1290          */
1291         uint16_t key_sz_in_bits;
1292         /**
1293          * [in] ptr to structure containing result field
1294          */
1295         uint8_t *em_record;
1296         /**
1297          * [out] result size in bits
1298          */
1299         uint16_t em_record_sz_in_bits;
1300         /**
1301          * [in] duplicate check flag
1302          */
1303         uint8_t dup_check;
1304         /**
1305          * [out] Flow handle value for the inserted entry.  This is encoded
1306          * as the entries[4]:bucket[2]:hashId[1]:hash[14]
1307          */
1308         uint64_t flow_handle;
1309         /**
1310          * [out] Flow id is returned as null (internal)
1311          * Flow id is the GFID value for the inserted entry (external)
1312          * This is the value written to the BD and useful information for mark.
1313          */
1314         uint64_t flow_id;
1315 };
1316 /**
1317  * tf_delete_em_entry parameter definition
1318  */
1319 struct tf_delete_em_entry_parms {
1320         /**
1321          * [in] receive or transmit direction
1322          */
1323         enum tf_dir dir;
1324         /**
1325          * [in] internal or external
1326          */
1327         enum tf_mem mem;
1328         /**
1329          * [in] ID of table scope to use (external only)
1330          */
1331         uint32_t tbl_scope_id;
1332         /**
1333          * [in] ID of table interface to use (Brd4 only)
1334          */
1335         uint32_t tbl_if_id;
1336         /**
1337          * [in] epoch group IDs of entry to delete
1338          * 2 element array with 2 ids. (Brd4 only)
1339          */
1340         uint16_t *epochs;
1341         /**
1342          * [out] The index of the entry
1343          */
1344         uint16_t index;
1345         /**
1346          * [in] structure containing flow delete handle information
1347          */
1348         uint64_t flow_handle;
1349 };
1350 /**
1351  * tf_search_em_entry parameter definition
1352  */
1353 struct tf_search_em_entry_parms {
1354         /**
1355          * [in] receive or transmit direction
1356          */
1357         enum tf_dir dir;
1358         /**
1359          * [in] internal or external
1360          */
1361         enum tf_mem mem;
1362         /**
1363          * [in] ID of table scope to use (external only)
1364          */
1365         uint32_t tbl_scope_id;
1366         /**
1367          * [in] ID of table interface to use (Brd4 only)
1368          */
1369         uint32_t tbl_if_id;
1370         /**
1371          * [in] ptr to structure containing key fields
1372          */
1373         uint8_t *key;
1374         /**
1375          * [in] key bit length
1376          */
1377         uint16_t key_sz_in_bits;
1378         /**
1379          * [in/out] ptr to structure containing EM record fields
1380          */
1381         uint8_t *em_record;
1382         /**
1383          * [out] result size in bits
1384          */
1385         uint16_t em_record_sz_in_bits;
1386         /**
1387          * [in] epoch group IDs of entry to lookup
1388          * 2 element array with 2 ids. (Brd4 only)
1389          */
1390         uint16_t *epochs;
1391         /**
1392          * [in] ptr to structure containing flow delete handle
1393          */
1394         uint64_t flow_handle;
1395 };
1396
1397 /**
1398  * insert em hash entry in internal table memory
1399  *
1400  * Internal:
1401  *
1402  * This API inserts an exact match entry into internal EM table memory
1403  * of the specified direction.
1404  *
1405  * Note: The EM record is managed within the TruFlow core and not the
1406  * application.
1407  *
1408  * Shadow copy of internal record table an association with hash and 1,2, or 4
1409  * associated buckets
1410  *
1411  * External:
1412  * This API inserts an exact match entry into DRAM EM table memory of the
1413  * specified direction and table scope.
1414  *
1415  * When inserting an entry into an exact match table, the TruFlow library may
1416  * need to allocate a dynamic bucket for the entry (Brd4 only).
1417  *
1418  * The insertion of duplicate entries in an EM table is not permitted.  If a
1419  * TruFlow application can guarantee that it will never insert duplicates, it
1420  * can disable duplicate checking by passing a zero value in the  dup_check
1421  * parameter to this API.  This will optimize performance. Otherwise, the
1422  * TruFlow library will enforce protection against inserting duplicate entries.
1423  *
1424  * Flow handle is defined in this document:
1425  *
1426  * https://docs.google.com
1427  * /document/d/1NESu7RpTN3jwxbokaPfYORQyChYRmJgs40wMIRe8_-Q/edit
1428  *
1429  * Returns success or busy code.
1430  *
1431  */
1432 int tf_insert_em_entry(struct tf *tfp,
1433                        struct tf_insert_em_entry_parms *parms);
1434
1435 /**
1436  * delete em hash entry table memory
1437  *
1438  * Internal:
1439  *
1440  * This API deletes an exact match entry from internal EM table memory of the
1441  * specified direction. If a valid flow ptr is passed in then that takes
1442  * precedence over the pointer to the complete key passed in.
1443  *
1444  *
1445  * External:
1446  *
1447  * This API deletes an exact match entry from EM table memory of the specified
1448  * direction and table scope. If a valid flow handle is passed in then that
1449  * takes precedence over the pointer to the complete key passed in.
1450  *
1451  * The TruFlow library may release a dynamic bucket when an entry is deleted.
1452  *
1453  *
1454  * Returns success or not found code
1455  *
1456  *
1457  */
1458 int tf_delete_em_entry(struct tf *tfp,
1459                        struct tf_delete_em_entry_parms *parms);
1460
1461 /**
1462  * search em hash entry table memory
1463  *
1464  * Internal:
1465
1466  * This API looks up an EM entry in table memory with the specified EM
1467  * key or flow (flow takes precedence) and direction.
1468  *
1469  * The status will be one of: success or entry not found.  If the lookup
1470  * succeeds, a pointer to the matching entry and the result record associated
1471  * with the matching entry will be provided.
1472  *
1473  * If flow_handle is set, search shadow copy.
1474  *
1475  * Otherwise, query the fw with key to get result.
1476  *
1477  * External:
1478  *
1479  * This API looks up an EM entry in table memory with the specified EM
1480  * key or flow_handle (flow takes precedence), direction and table scope.
1481  *
1482  * The status will be one of: success or entry not found.  If the lookup
1483  * succeeds, a pointer to the matching entry and the result record associated
1484  * with the matching entry will be provided.
1485  *
1486  * Returns success or not found code
1487  *
1488  */
1489 int tf_search_em_entry(struct tf *tfp,
1490                        struct tf_search_em_entry_parms *parms);
1491 #endif /* _TF_CORE_H_ */