Lines Matching full:fm
37 @Description FM Application Programming Interface.
50 @Description FM API functions, definitions and enums.
56 @Group FM_lib_grp FM library
58 @Description FM API functions, definitions and enums.
60 The FM module is the main driver module and is a mandatory module
61 for FM driver users. This module must be initialized first prior
63 The FM is a "singleton" module. It is responsible of the common
66 when working with any of the FM modules.
67 NOTE - We assume that the FM library will be initialized only by core No. 0!
85 @Collection General FM defines
88 #define FM_PHYS_ADDRESS_SIZE 6 /**< FM Physical address size */
97 @Description FM physical Address
134 @Collection FM Parser results
145 @Collection FM Frame descriptor macros
290 @Description FM Exceptions
294 e_FM_EX_DMA_READ_ECC, /**< Read Buffer ECC error (Valid for FM rev < 6)*/
295 …e_FM_EX_DMA_SYSTEM_WRITE_ECC, /**< Write Buffer ECC error on system side (Valid for FM rev <…
296 …e_FM_EX_DMA_FM_WRITE_ECC, /**< Write Buffer ECC error on FM side (Valid for FM rev < 6)*/
297 … e_FM_EX_DMA_SINGLE_PORT_ECC, /**< Single Port ECC error on FM side (Valid for FM rev > 6)*/
333 @Group FM_init_grp FM Initialization Unit
335 @Description FM Initialization Unit
338 Initialization of the FM Module will be carried out by the application
387 bool passPrsResult; /**< TRUE to pass the parse result to/from the FM;
390 bool passTimeStamp; /**< TRUE to pass the timeStamp to/from the FM
393 bool passHashResult; /**< TRUE to pass the KG hash result to/from the FM
472 @Description A Structure for defining FM initialization parameters
475 uint8_t fmId; /**< Index of the FM */
476 uint8_t guestId; /**< FM Partition Id */
477 …uintptr_t baseAddr; /**< A pointer to base of memory mapped FM registe…
478 … this field is optional when the FM runs in "guest-mode"
481 … NOTE that this should include ALL common registers of the FM including
484 to be used by the FM. */
486 … Relevant when FM not runs in "guest-mode". */
487 …uint16_t fmMacClkRatio; /**< FM MAC Clock ratio, for backward comparabilit…
491 … Relevant when FM not runs in "guest-mode". */
493 … Relevant when FM not runs in "guest-mode". */
496 … Relevant when FM not runs in "guest-mode". */
497 uintptr_t irq; /**< FM interrupt source for normal events;
498 … Relevant when FM not runs in "guest-mode". */
499 uintptr_t errIrq; /**< FM interrupt source for errors;
500 … Relevant when FM not runs in "guest-mode". */
502 … Relevant when FM not runs in "guest-mode". */
505 …uintptr_t vspBaseAddr; /**< A pointer to base of memory mapped FM VSP reg…
518 @Description Creates the FM module and returns its handle (descriptor).
520 FM function calls.
522 No actual initialization or configuration of FM hardware is
523 done by this routine. All FM parameters get default values that
526 @Param[in] p_FmParams - A pointer to a data structure of mandatory FM parameters
528 @Return A handle to the FM object, or NULL for Failure.
535 @Description Initializes the FM module by defining the software structure
538 @Param[in] h_Fm - FM module descriptor
547 @Description Frees all resources that were assigned to FM module.
551 @Param[in] h_Fm - FM module descriptor
559 @Group FM_advanced_init_grp FM Advanced Configuration Unit
655 @Description structure for defining FM threshold
659 … be passed in the FM before assumed to
702 @Description Define whether to reset the FM before initialization.
705 @Param[in] h_Fm A handle to an FM Module.
706 @Param[in] enable When TRUE, FM will be reset before any initialization.
719 @Description Define a special reset of FM before initialization.
722 @Param[in] h_Fm A handle to an FM Module.
723 @Param[in] f_ResetOnInitOverride FM specific reset on init user callback routine.
736 @Description Define Total FIFO size for the whole FM.
740 @Param[in] h_Fm A handle to an FM Module.
758 @Param[in] h_Fm A handle to an FM Module.
776 @Param[in] h_Fm A handle to an FM Module.
794 @Param[in] h_Fm A handle to an FM Module.
812 @Param[in] h_Fm A handle to an FM Module.
830 @Param[in] h_Fm A handle to an FM Module.
846 @Param[in] h_Fm A handle to an FM Module.
859 @Param[in] h_Fm A handle to an FM Module.
878 @Param[in] h_Fm A handle to an FM Module.
898 @Param[in] h_Fm A handle to an FM Module.
917 @Param[in] h_Fm A handle to an FM Module.
931 @Description Define FM behavior on catastrophic error.
932 Calling this routine changes the FM behavior on catastrophic
936 @Param[in] h_Fm A handle to an FM Module.
953 This routine is only avaiable on old FM revisions (FMan v2).
955 @Param[in] h_Fm A handle to an FM Module.
971 This routine is only avaiable on old FM revisions (FMan v2).
973 @Param[in] h_Fm A handle to an FM Module.
986 @Description Define FM behavior on external halt activation.
987 Calling this routine changes the FM behavior on external halt
991 @Param[in] h_Fm A handle to an FM Module.
1006 @Description Define FM behavior on external halt activation.
1007 Calling this routine changes the FM behavior on unrecoverable
1010 This routine is only avaiable on old FM revisions (FMan v2).
1012 @Param[in] h_Fm A handle to an FM Module.
1026 @Description Define FM exceptions.
1030 @Param[in] h_Fm A handle to an FM Module.
1051 @Param[in] h_Fm A handle to an FM Module.
1070 @Param[in] h_Fm A handle to an FM Module.
1073 64 FM clocks. Driver will pick the closest
1095 @Param[in] h_Fm A handle to an FM Module.
1110 from its default FM threshold configuration:
1122 @Param[in] h_Fm A handle to an FM Module.
1139 @Param[in] h_Fm A handle to an FM Module.
1157 This routine is only avaiable on old FM revisions (FMan v2).
1159 @Param[in] h_Fm A handle to an FM Module.
1180 @Param[in] h_Fm A handle to an FM Module.
1200 This routine is only avaiable on old FM revisions (FMan v2).
1202 @Param[in] h_Fm A handle to an FM Module.
1222 @Param[in] h_Fm A handle to an FM Module.
1238 @Group FM_runtime_control_grp FM Runtime Control Unit
1240 @Description FM Runtime control unit API functions, definitions and enums.
1241 The FM driver provides a set of control routines.
1252 @Collection General FM defines.
1258 … FM_MAX_NUM_OF_10G_TX_PORTS) /**< Number of available FM ports */
1266 e_FmPortType type; /**< FM port type */
1294 @Description Enum for defining FM counters
1310 @Description A Structure for returning FM revision information
1318 @Description A Structure for returning FM ctrl code revision information
1332 bool readBufEccError; /**< Double ECC error on buffer Read (Valid for FM rev < 6)*/
1333 …eBufEccSysError; /**< Double ECC error on buffer write from system side (Valid for FM rev < 6)*/
1334 …riteBufEccFmError; /**< Double ECC error on buffer write from FM side (Valid for FM rev < 6) */
1335 … bool singlePortEccError; /**< Single Port ECC error from FM side (Valid for FM rev >= 6)*/
1339 @Description A Structure for obtaining FM controller monitor values
1350 @Description Dumps all FM registers
1352 @Param[in] h_Fm A handle to an FM Module.
1366 @Param[in] h_Fm A handle to an FM Module.
1381 @Description Enables ECC mechanism for all the different FM RAM's; E.g. IRAM,
1389 @Param[in] h_Fm A handle to an FM Module.
1402 @Description Disables ECC mechanism for all the different FM RAM's; E.g. IRAM,
1410 @Param[in] h_Fm A handle to an FM Module.
1423 @Description Returns the FM revision
1425 @Param[in] h_Fm A handle to an FM Module.
1439 @Param[in] h_Fm A handle to an FM Module.
1451 @Description Reads one of the FM counters.
1453 @Param[in] h_Fm A handle to an FM Module.
1470 @Param[in] h_Fm A handle to an FM Module.
1485 @Description Release FM after halt FM command or after unrecoverable ECC error.
1487 @Param[in] h_Fm A handle to an FM Module.
1502 @Param[in] h_Fm A handle to an FM Module.
1519 @Param[in] h_Fm A handle to an FM Module.
1535 @Param[in] h_Fm A handle to an FM Module.
1545 @Description FM interrupt-service-routine for errors.
1547 @Param[in] h_Fm A handle to an FM Module.
1561 @Description FM interrupt-service-routine for normal events.
1563 @Param[in] h_Fm A handle to an FM Module.
1576 @Param[in] h_Fm A handle to an FM Module.
1591 @Description Start monitoring utilization of all available FM controllers.
1593 In order to obtain FM controllers utilization the following sequence
1597 -# FM_CtrlMonGetCounters() - issued for each FM controller
1599 @Param[in] h_Fm A handle to an FM Module.
1612 @Description Stop monitoring utilization of all available FM controllers.
1614 In order to obtain FM controllers utilization the following sequence
1618 -# FM_CtrlMonGetCounters() - issued for each FM controller
1620 @Param[in] h_Fm A handle to an FM Module.
1633 @Description Obtain FM controller utilization parameters.
1635 In order to obtain FM controllers utilization the following sequence
1639 -# FM_CtrlMonGetCounters() - issued for each FM controller
1641 @Param[in] h_Fm A handle to an FM Module.
1642 @Param[in] fmCtrlIndex FM Controller index for that utilization results
1660 @Param[in] h_Fm A handle to an FM Module.
1677 @Param[in] h_Fm A handle to an FM Module.
1694 @Param[in] h_Fm A handle to an FM Module.