openbcm

Git mirror of https://github.com/Broadcom-Network-Switching-Software/OpenBCM
git clone git://git.finwo.net/mirror/broadcom/openbcm
Log | Files | Refs | README

spb.h (1570B)

      1 /** \file bcm_int/dnx/spb/spb.h
      2  *
      3  * sram packet buffer internal.
      4  */
      5 /*
      6  * This license is set out in https://raw.githubusercontent.com/Broadcom-Network-Switching-Software/OpenBCM/master/Legal/LICENSE file.
      7  * 
      8  * Copyright 2007-2020 Broadcom Inc. All rights reserved.
      9  */
     10 #ifndef _DNX_SPB_API_INCLUDED__
     11 /*
     12  * { 
     13  */
     14 #define _DNX_SPB_API_INCLUDED__
     15 
     16 #ifndef BCM_DNX_SUPPORT
     17 #error "This file is for use by DNX (JR2) family only!"
     18 #endif
     19 
     20 /*
     21  * Include files.
     22  * {
     23  */
     24 #include <shared/shrextend/shrextend_debug.h>
     25 /*
     26  * }
     27  */
     28 
     29 /**
     30  * \brief - Call Back function for mem_init mechanism, will init the context MRU to simulation values
     31  * 
     32  * \param [in] unit - unit number
     33  * \param [in] array_index - irrelevant for this cb
     34  * \param [in] copyno - irrelevant for this cb
     35  * \param [in] index - irrelevant for this cb
     36  * \param [in] entry_data - returned value to set to memory
     37  *   
     38  * \return
     39  *   shr_error_e 
     40  *   
     41  * \remark
     42  *   * None
     43  * \see
     44  *   * None
     45  */
     46 shr_error_e dnx_spb_context_mru_default_get_f(
     47     int unit,
     48     unsigned array_index,
     49     int copyno,
     50     int index,
     51     uint32 *entry_data);
     52 
     53 /**
     54  * \brief - Initialize dnx spb module
     55  * 
     56  * \param [in] unit - unit number
     57  *   
     58  * \return
     59  *   shr_error_e 
     60  *   
     61  * \remark
     62  *   * None
     63  * \see
     64  *   * None
     65  */
     66 shr_error_e dnx_spb_init(
     67     int unit);
     68 
     69 /**
     70  * \brief - De-initialize dnx spb module
     71  * 
     72  * \param [in] unit - unit number
     73  *   
     74  * \return
     75  *   shr_error_e 
     76  *   
     77  * \remark
     78  *   * None
     79  * \see
     80  *   * None
     81  */
     82 shr_error_e dnx_spb_deinit(
     83     int unit);
     84 
     85 #endif/*_DNX_SPB_API_INCLUDED__*/