init_custom_funcs.h (13099B)
1 /** \file init_custom_funcs.h 2 * Custom functions to be used to initialize DNX memories. 3 */ 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 11 #ifndef _BCMINT_DNX_INIT_CUSTOM_FUNCS_H_INCLUDED 12 /* 13 * { 14 */ 15 #define _BCMINT_DNX_INIT_CUSTOM_FUNCS_H_INCLUDED 16 17 #ifndef BCM_DNX_SUPPORT 18 #error "This file is for use by DNX family only!" 19 #endif 20 21 /* 22 * Include files. 23 * { 24 */ 25 26 #include <shared/shrextend/shrextend_debug.h> 27 /* 28 * } 29 */ 30 31 /** 32 * \brief - set entry_data with the init value of SCH_FLOW_TO_FIP_MAPPING_FFM memory 33 * 34 * \param [in] unit - unit number 35 * \param [in] array_index - irrelevant for this cb 36 * \param [in] copyno - irrelevant for this cb 37 * \param [in] index - irrelevant for this cb 38 * \param [in] entry_data - returned value to set to memory 39 * 40 * \return 41 * shr_error_e 42 * 43 * \remark 44 * * None 45 * \see 46 * * None 47 */ 48 shr_error_e dnx_init_custom_sch_flow_to_fip_mapping_default_get( 49 int unit, 50 unsigned array_index, 51 int copyno, 52 int index, 53 uint32 *entry_data); 54 55 /** 56 * \brief - set entry_data with the init value of SCH_SHAPER_DESCRIPTOR_MEMORY_STATIC_SHDS memory 57 * 58 * \param [in] unit - unit number 59 * \param [in] array_index - irrelevant for this cb 60 * \param [in] copyno - irrelevant for this cb 61 * \param [in] index - irrelevant for this cb 62 * \param [in] entry_data - returned value to set to memory 63 * 64 * \return 65 * shr_error_e 66 * 67 * \remark 68 * * None 69 * \see 70 * * None 71 */ 72 shr_error_e dnx_init_custom_sch_shaper_descr_default_get( 73 int unit, 74 unsigned array_index, 75 int copyno, 76 int index, 77 uint32 *entry_data); 78 79 /** 80 * \brief - set entry_data with the init value of SCH_PORT_SCHEDULER_WEIGHTS_PSW memory 81 * 82 * \param [in] unit - unit number 83 * \param [in] array_index - irrelevant for this cb 84 * \param [in] copyno - irrelevant for this cb 85 * \param [in] index - irrelevant for this cb 86 * \param [in] entry_data - returned value to set to memory 87 * 88 * \return 89 * shr_error_e 90 * 91 * \remark 92 * * None 93 * \see 94 * * None 95 */ 96 shr_error_e dnx_init_custom_sch_port_schduler_weights_psw_default_get( 97 int unit, 98 unsigned array_index, 99 int copyno, 100 int index, 101 uint32 *entry_data); 102 103 /** 104 * \brief - set entry_data with the init value of SCH_FLOW_DESCRIPTOR_MEMORY_STATIC_FDMSm memory 105 * 106 * \param [in] unit - unit number 107 * \param [in] array_index - irrelevant for this cb 108 * \param [in] copyno - irrelevant for this cb 109 * \param [in] index - irrelevant for this cb 110 * \param [in] entry_data - returned value to set to memory 111 * 112 * \return 113 * shr_error_e 114 * 115 * \remark 116 * * None 117 * \see 118 * * None 119 */ 120 shr_error_e dnx_init_custom_sch_flow_descr_default_get( 121 int unit, 122 unsigned array_index, 123 int copyno, 124 int index, 125 uint32 *entry_data); 126 127 /** 128 * \brief - set entry_data with the init value of IPT_PCP_CFGm memory 129 * 130 * \param [in] unit - unit number 131 * \param [in] array_index - irrelevant for this cb 132 * \param [in] copyno - irrelevant for this cb 133 * \param [in] index - irrelevant for this cb 134 * \param [in] entry_data - returned value to set to memory 135 * 136 * \return 137 * shr_error_e 138 * 139 * \remark 140 * * None 141 * \see 142 * * None 143 */ 144 shr_error_e dnx_init_custom_fabric_pcp_default_get( 145 int unit, 146 unsigned array_index, 147 int copyno, 148 int index, 149 uint32 *entry_data); 150 151 /** 152 * \brief - set entry_data with the init value of ERPP_TM_PP_DSP_PTR_TABLEm memory 153 * 154 * \param [in] unit - unit number 155 * \param [in] array_index - irrelevant for this cb 156 * \param [in] copyno - irrelevant for this cb 157 * \param [in] index - irrelevant for this cb 158 * \param [in] entry_data - returned value to set to memory 159 * 160 * \return 161 * shr_error_e 162 * 163 * \remark 164 * * None 165 * \see 166 * * None 167 */ 168 shr_error_e dnx_init_custom_erpp_tm_pp_dsp_ptr_table_get( 169 int unit, 170 unsigned array_index, 171 int copyno, 172 int index, 173 uint32 *entry_data); 174 175 /** 176 * \brief - set entry_data with the init value of ERPP_PRP_PP_DSP_PTR_TABLEm memory 177 * 178 * \param [in] unit - unit number 179 * \param [in] array_index - irrelevant for this cb 180 * \param [in] copyno - irrelevant for this cb 181 * \param [in] index - irrelevant for this cb 182 * \param [in] entry_data - returned value to set to memory 183 * 184 * \return 185 * shr_error_e 186 * 187 * \remark 188 * * None 189 * \see 190 * * None 191 */ 192 shr_error_e dnx_init_custom_erpp_prp_pp_dsp_ptr_table_get( 193 int unit, 194 unsigned array_index, 195 int copyno, 196 int index, 197 uint32 *entry_data); 198 199 /** 200 * \brief - set entry_data with the init value of ETPPA_DSP_DATA_TABLEm memory 201 * 202 * \param [in] unit - unit number 203 * \param [in] array_index - irrelevant for this cb 204 * \param [in] copyno - irrelevant for this cb 205 * \param [in] index - irrelevant for this cb 206 * \param [in] entry_data - returned value to set to memory 207 * 208 * \return 209 * shr_error_e 210 * 211 * \remark 212 * * None 213 * \see 214 * * None 215 */ 216 shr_error_e dnx_init_custom_etppa_dsp_data_table_get( 217 int unit, 218 unsigned array_index, 219 int copyno, 220 int index, 221 uint32 *entry_data); 222 223 /** 224 * \brief - set entry_data with the init value of IPPC_FES_2ND_INSTRUCTIONm memory 225 * 226 * \param [in] unit - unit number 227 * \param [in] array_index - irrelevant for this cb 228 * \param [in] copyno - irrelevant for this cb 229 * \param [in] index - irrelevant for this cb 230 * \param [in] entry_data - returned value to set to memory 231 * 232 * \return 233 * shr_error_e 234 * 235 * \remark 236 * * None 237 * \see 238 * * None 239 */ 240 shr_error_e dnx_init_custom_ippc_fes_2nd_instruction_default_get( 241 int unit, 242 unsigned array_index, 243 int copyno, 244 int index, 245 uint32 *entry_data); 246 247 /** 248 * \brief - set entry_data with the init value of IPPD_FES_2ND_INSTRUCTIONm memory 249 * 250 * \param [in] unit - unit number 251 * \param [in] array_index - irrelevant for this cb 252 * \param [in] copyno - irrelevant for this cb 253 * \param [in] index - irrelevant for this cb 254 * \param [in] entry_data - returned value to set to memory 255 * 256 * \return 257 * shr_error_e 258 * 259 * \remark 260 * * None 261 * \see 262 * * None 263 */ 264 shr_error_e dnx_init_custom_ippd_fes_2nd_instruction_default_get( 265 int unit, 266 unsigned array_index, 267 int copyno, 268 int index, 269 uint32 *entry_data); 270 271 /** 272 * \brief - set entry_data with the init value of ERPP_FES_2ND_INSTRUCTIONm memory 273 * 274 * \param [in] unit - unit number 275 * \param [in] array_index - irrelevant for this cb 276 * \param [in] copyno - irrelevant for this cb 277 * \param [in] index - irrelevant for this cb 278 * \param [in] entry_data - returned value to set to memory 279 * 280 * \return 281 * shr_error_e 282 * 283 * \remark 284 * * None 285 * \see 286 * * None 287 */ 288 shr_error_e dnx_init_custom_erpp_fes_2nd_instruction_default_get( 289 int unit, 290 unsigned array_index, 291 int copyno, 292 int index, 293 uint32 *entry_data); 294 295 /** 296 * \brief - set entry_data with the init value of ETPPA_PRP_FES_PROGRAM_TABLEm memory 297 * 298 * \param [in] unit - unit number 299 * \param [in] array_index - irrelevant for this cb 300 * \param [in] copyno - irrelevant for this cb 301 * \param [in] index - irrelevant for this cb 302 * \param [in] entry_data - returned value to set to memory 303 * 304 * \return 305 * shr_error_e 306 * 307 * \remark 308 * * None 309 * \see 310 * * None 311 */ 312 shr_error_e dnx_init_custom_etppa_prp_fes_program_table_default_get( 313 int unit, 314 unsigned array_index, 315 int copyno, 316 int index, 317 uint32 *entry_data); 318 319 /** 320 * \brief - set entry_data with the init value of SCH_CIR_SHAPERS_STATIC_TABEL_CSST memory 321 * 322 * \param [in] unit - unit number 323 * \param [in] array_index - irrelevant for this cb 324 * \param [in] copyno - irrelevant for this cb 325 * \param [in] index - irrelevant for this cb 326 * \param [in] entry_data - returned value to set to memory 327 * 328 * \return 329 * shr_error_e 330 * 331 * \remark 332 * * None 333 * \see 334 * * None 335 */ 336 shr_error_e dnx_init_custom_sch_csst_default_get( 337 int unit, 338 unsigned array_index, 339 int copyno, 340 int index, 341 uint32 *entry_data); 342 343 /** 344 * \brief - set entry_data with the init value of SCH_PIR_SHAPERS_STATIC_TABEL_PSST memory 345 * 346 * \param [in] unit - unit number 347 * \param [in] array_index - irrelevant for this cb 348 * \param [in] copyno - irrelevant for this cb 349 * \param [in] index - irrelevant for this cb 350 * \param [in] entry_data - returned value to set to memory 351 * 352 * \return 353 * shr_error_e 354 * 355 * \remark 356 * * None 357 * \see 358 * * None 359 */ 360 shr_error_e dnx_init_custom_sch_psst_default_get( 361 int unit, 362 unsigned array_index, 363 int copyno, 364 int index, 365 uint32 *entry_data); 366 367 /** 368 * \brief - set entry_data with the init value of CGM_IPP_MAP memory 369 * 370 * \param [in] unit - unit number 371 * \param [in] array_index - irrelevant for this cb 372 * \param [in] copyno - irrelevant for this cb 373 * \param [in] index - irrelevant for this cb 374 * \param [in] entry_data - returned value to set to memory 375 * 376 * \return 377 * shr_error_e 378 * 379 * \remark 380 * * None 381 * \see 382 * * None 383 */ 384 shr_error_e dnx_init_custom_cgm_ipp_map_default_get( 385 int unit, 386 unsigned array_index, 387 int copyno, 388 int index, 389 uint32 *entry_data); 390 391 /** 392 * \brief - set entry_data with the init value of IPPC_FEM_BIT_SELECTm memory 393 * 394 * \param [in] unit - unit number 395 * \param [in] array_index - irrelevant for this cb 396 * \param [in] copyno - irrelevant for this cb 397 * \param [in] index - irrelevant for this cb 398 * \param [in] entry_data - returned value to set to memory 399 * 400 * \return 401 * shr_error_e 402 * 403 * \remark 404 * * None 405 * \see 406 * * None 407 */ 408 shr_error_e dnx_init_custom_ippc_fem_bit_select_default_get( 409 int unit, 410 unsigned array_index, 411 int copyno, 412 int index, 413 uint32 *entry_data); 414 415 /** 416 * \brief - set entry_data with the init value of IPPC_FEM_MAP_INDEX_TABLEm memory 417 * 418 * \param [in] unit - unit number 419 * \param [in] array_index - irrelevant for this cb 420 * \param [in] copyno - irrelevant for this cb 421 * \param [in] index - irrelevant for this cb 422 * \param [in] entry_data - returned value to set to memory 423 * 424 * \return 425 * shr_error_e 426 * 427 * \remark 428 * * None 429 * \see 430 * * None 431 */ 432 shr_error_e dnx_init_custom_ippc_fem_map_index_table_default_get( 433 int unit, 434 unsigned array_index, 435 int copyno, 436 int index, 437 uint32 *entry_data); 438 439 /** 440 * \brief - set entry_data with the init value of TCAM_TCAM_BANK_COMMANDm memory 441 * 442 * \param [in] unit - unit number 443 * \param [in] array_index - irrelevant for this cb 444 * \param [in] copyno - irrelevant for this cb 445 * \param [in] index - irrelevant for this cb 446 * \param [in] entry_data - returned value to set to memory 447 * 448 * \return 449 * shr_error_e 450 * 451 * \remark 452 * * None 453 * \see 454 * * None 455 */ 456 shr_error_e dnx_init_custom_tcam_tcam_bank_command_default_get( 457 int unit, 458 unsigned array_index, 459 int copyno, 460 int index, 461 uint32 *entry_data); 462 463 /** 464 * \brief - set entry_data with the init value of TCAM_TCAM_ACTIONm memory 465 * 466 * \param [in] unit - unit number 467 * \param [in] array_index - irrelevant for this cb 468 * \param [in] copyno - irrelevant for this cb 469 * \param [in] index - irrelevant for this cb 470 * \param [in] entry_data - returned value to set to memory 471 * 472 * \return 473 * shr_error_e 474 * 475 * \remark 476 * * None 477 * \see 478 * * None 479 */ 480 shr_error_e dnx_init_custom_tcam_tcam_action_default_get( 481 int unit, 482 unsigned array_index, 483 int copyno, 484 int index, 485 uint32 *entry_data); 486 487 /** 488 * \brief - set entry_data with the init value of TCAM_TCAM_ACTION_SMALLm memory 489 * 490 * \param [in] unit - unit number 491 * \param [in] array_index - irrelevant for this cb 492 * \param [in] copyno - irrelevant for this cb 493 * \param [in] index - irrelevant for this cb 494 * \param [in] entry_data - returned value to set to memory 495 * 496 * \return 497 * shr_error_e 498 * 499 * \remark 500 * * None 501 * \see 502 * * None 503 */ 504 shr_error_e dnx_init_custom_tcam_tcam_action_small_default_get( 505 int unit, 506 unsigned array_index, 507 int copyno, 508 int index, 509 uint32 *entry_data); 510 511 /** 512 * \brief - set MTU of MACSEC_ESEC_SC_TABLE to 64 513 * 514 * \param [in] unit - unit number 515 * \param [in] array_index - irrelevant for this cb 516 * \param [in] copyno - irrelevant for this cb 517 * \param [in] index - irrelevant for this cb 518 * \param [in] entry_data - returned value to set to memory 519 * 520 * \return 521 * shr_error_e 522 * 523 * \remark 524 * * None 525 * \see 526 * * None 527 */ 528 shr_error_e dnx_init_custom_xflow_macsec_default_esec_sc_entry_get( 529 int unit, 530 unsigned array_index, 531 int copyno, 532 int index, 533 uint32 *entry_data); 534 535 /** 536 * \brief - set MTU of MACSEC_SUB_PORT_POLICY_TABLE to 300 537 * 538 * \param [in] unit - unit number 539 * \param [in] array_index - irrelevant for this cb 540 * \param [in] copyno - irrelevant for this cb 541 * \param [in] index - irrelevant for this cb 542 * \param [in] entry_data - returned value to set to memory 543 * 544 * \return 545 * shr_error_e 546 * 547 * \remark 548 * * None 549 * \see 550 * * None 551 */ 552 shr_error_e dnx_init_custom_xflow_macsec_default_isec_policy_entry_get( 553 int unit, 554 unsigned array_index, 555 int copyno, 556 int index, 557 uint32 *entry_data); 558 559 #endif /** _BCMINT_DNX_INIT_CUSTOM_FUNCS_H_INCLUDED */