summaryrefslogtreecommitdiff
path: root/drivers/net/ethernet/freescale/fman/inc/Peripherals
diff options
context:
space:
mode:
authorMandy Lavi <mandy.lavi@freescale.com>2013-04-24 07:56:04 (GMT)
committerFleming Andrew-AFLEMING <AFLEMING@freescale.com>2013-04-29 20:22:02 (GMT)
commit5045184a0cc3283bcd30d3bbebff6188d30e9fce (patch)
treef47057a56b74a822fe8329767802f4ff59711e3f /drivers/net/ethernet/freescale/fman/inc/Peripherals
parent56206bd9f58df8e2a1640c523d6f7fa392e580d1 (diff)
downloadlinux-fsl-qoriq-5045184a0cc3283bcd30d3bbebff6188d30e9fce.tar.xz
fmd21 integration
Signed-off-by: Mandy Lavi <mandy.lavi@freescale.com> Prev fmd integration was fmd19 Diffs from fmd19 to fmd21: Added kgHashShift to t_FmPcdHashTableParams Added nonConsistentSp to t_FmPcdManipReassemIpStats sp - 2 layers separation - for future flib integration rtc - 2 layers separation - for future flib integration PFC enhancement (B4 Rev2 FMAN) API addition (for B4 rev 2): FM_PORT_SetPfcPrioritiesMappingToQmanWQ File fsl_fman.h renamed to lnxwrp_fsl_fman.h The name fsl_fman.h has been applied to other fman internal header file In dpaa_eth: Due to renaming of fsl_fman.h to lnxwrp_fsl_fman.h The relevant include lines in some of the files had to change accordingly Change-Id: I8f25c758963a44a75ca8676aad45f7f96767b0b5 Reviewed-on: http://git.am.freescale.net:8181/2069 Reviewed-by: Fleming Andrew-AFLEMING <AFLEMING@freescale.com> Tested-by: Fleming Andrew-AFLEMING <AFLEMING@freescale.com>
Diffstat (limited to 'drivers/net/ethernet/freescale/fman/inc/Peripherals')
-rw-r--r--drivers/net/ethernet/freescale/fman/inc/Peripherals/fm_ext.h89
-rw-r--r--drivers/net/ethernet/freescale/fman/inc/Peripherals/fm_mac_ext.h50
-rw-r--r--drivers/net/ethernet/freescale/fman/inc/Peripherals/fm_pcd_ext.h27
-rw-r--r--drivers/net/ethernet/freescale/fman/inc/Peripherals/fm_port_ext.h87
-rw-r--r--drivers/net/ethernet/freescale/fman/inc/Peripherals/fm_rtc_ext.h32
5 files changed, 159 insertions, 126 deletions
diff --git a/drivers/net/ethernet/freescale/fman/inc/Peripherals/fm_ext.h b/drivers/net/ethernet/freescale/fman/inc/Peripherals/fm_ext.h
index 6acf50b..a45682f 100644
--- a/drivers/net/ethernet/freescale/fman/inc/Peripherals/fm_ext.h
+++ b/drivers/net/ethernet/freescale/fman/inc/Peripherals/fm_ext.h
@@ -42,7 +42,7 @@
#include "error_ext.h"
#include "std_ext.h"
#include "dpaa_ext.h"
-
+#include "fsl_fman_sp.h"
/**************************************************************************//**
@Group FM_grp Frame Manager API
@@ -55,7 +55,7 @@
/**************************************************************************//**
@Group FM_lib_grp FM library
- @Description FM API functions, definitions and enums
+ @Description FM API functions, definitions and enums.
The FM module is the main driver module and is a mandatory module
for FM driver users. This module must be initialized first prior
@@ -235,6 +235,7 @@ typedef uint32_t fmSpecialOperations_t; /**< typedef for definin
#define FM_SP_OP_RPD 0x10000000 /**< Set the RPD bit */
#define FM_SP_OP_DCL4C 0x08000000 /**< Set the DCL4C bit */
#define FM_SP_OP_CHECK_SEC_ERRORS 0x04000000 /**< Check SEC errors */
+#define FM_SP_OP_CLEAR_RPD 0x02000000 /**< Clear the RPD bit */
/* @} */
/**************************************************************************//**
@@ -309,19 +310,19 @@ typedef enum e_FmExceptions {
@Description Enum for defining port DMA swap mode
*//***************************************************************************/
typedef enum e_FmDmaSwapOption {
- e_FM_DMA_NO_SWP, /**< No swap, transfer data as is.*/
- e_FM_DMA_SWP_PPC_LE, /**< The transferred data should be swapped
- in PowerPc Little Endian mode. */
- e_FM_DMA_SWP_BE /**< The transferred data should be swapped
- in Big Endian mode */
+ e_FM_DMA_NO_SWP = FMAN_DMA_NO_SWP, /**< No swap, transfer data as is.*/
+ e_FM_DMA_SWP_PPC_LE = FMAN_DMA_SWP_PPC_LE, /**< The transferred data should be swapped
+ in PowerPc Little Endian mode. */
+ e_FM_DMA_SWP_BE = FMAN_DMA_SWP_BE /**< The transferred data should be swapped
+ in Big Endian mode */
} e_FmDmaSwapOption;
/**************************************************************************//**
@Description Enum for defining port DMA cache attributes
*//***************************************************************************/
typedef enum e_FmDmaCacheOption {
- e_FM_DMA_NO_STASH = 0, /**< Cacheable, no Allocate (No Stashing) */
- e_FM_DMA_STASH = 1 /**< Cacheable and Allocate (Stashing on) */
+ e_FM_DMA_NO_STASH = FMAN_DMA_NO_STASH, /**< Cacheable, no Allocate (No Stashing) */
+ e_FM_DMA_STASH = FMAN_DMA_STASH /**< Cacheable and Allocate (Stashing on) */
} e_FmDmaCacheOption;
@@ -391,7 +392,7 @@ typedef struct t_FmBufferPrefixContent {
get the parser-result from a buffer. */
bool passAllOtherPCDInfo;/**< Add all other Internal-Context information:
AD, hash-result, key, etc. */
- uint16_t dataAlign; /**< 0 to use driver's default alignment [64],
+ uint16_t dataAlign; /**< 0 to use driver's default alignment [DEFAULT_FM_SP_bufferPrefixContent_dataAlign],
other value for selecting a data alignment (must be a power of 2);
if write optimization is used, must be >= 16. */
uint8_t manipExtraSpace; /**< Maximum extra size needed (insertion-size minus removal-size);
@@ -684,7 +685,7 @@ typedef struct t_FmDmaThresholds {
@Function FM_ConfigResetOnInit
@Description Define whether to reset the FM before initialization.
- Change the default configuration [FALSE].
+ Change the default configuration [DEFAULT_resetOnInit].
@Param[in] h_Fm A handle to an FM Module.
@Param[in] enable When TRUE, FM will be reset before any initialization.
@@ -702,7 +703,7 @@ t_Error FM_ConfigResetOnInit(t_Handle h_Fm, bool enable);
@Description Define Total FIFO size for the whole FM.
Calling this routine changes the total Fifo size in the internal driver
- data base from its default configuration [major]
+ data base from its default configuration [DEFAULT_totalFifoSize]
@Param[in] h_Fm A handle to an FM Module.
@Param[in] totalFifoSize The selected new value.
@@ -720,7 +721,7 @@ t_Error FM_ConfigTotalFifoSize(t_Handle h_Fm, uint32_t totalFifoSize);
@Description Define cache override mode.
Calling this routine changes the cache override mode
- in the internal driver data base from its default configuration [e_FM_DMA_NO_CACHE_OR]
+ in the internal driver data base from its default configuration [DEFAULT_cacheOverride]
@Param[in] h_Fm A handle to an FM Module.
@Param[in] cacheOverride The selected new value.
@@ -738,7 +739,7 @@ t_Error FM_ConfigDmaCacheOverride(t_Handle h_Fm, e_FmDmaCacheOverride cacheOverr
@Description Define DMA AID override mode.
Calling this routine changes the AID override mode
- in the internal driver data base from its default configuration [TRUE]
+ in the internal driver data base from its default configuration [DEFAULT_aidOverride]
@Param[in] h_Fm A handle to an FM Module.
@Param[in] aidOverride The selected new value.
@@ -756,7 +757,7 @@ t_Error FM_ConfigDmaAidOverride(t_Handle h_Fm, bool aidOverride);
@Description Define DMA AID mode.
Calling this routine changes the AID mode in the internal
- driver data base from its default configuration [e_FM_DMA_AID_OUT_TNUM]
+ driver data base from its default configuration [DEFAULT_aidMode]
@Param[in] h_Fm A handle to an FM Module.
@Param[in] aidMode The selected new value.
@@ -774,7 +775,7 @@ t_Error FM_ConfigDmaAidMode(t_Handle h_Fm, e_FmDmaAidMode aidMode);
@Description Define DMA AXI number of beats.
Calling this routine changes the AXI number of beats in the internal
- driver data base from its default configuration [1]
+ driver data base from its default configuration [DEFAULT_axiDbgNumOfBeats]
@Param[in] h_Fm A handle to an FM Module.
@Param[in] axiDbgNumOfBeats The selected new value.
@@ -792,7 +793,7 @@ t_Error FM_ConfigDmaAxiDbgNumOfBeats(t_Handle h_Fm, uint8_t axiDbgNumOfBeats);
@Description Define number of CAM entries.
Calling this routine changes the number of CAM entries in the internal
- driver data base from its default configuration [32].
+ driver data base from its default configuration [DEFAULT_dmaCamNumOfEntries].
@Param[in] h_Fm A handle to an FM Module.
@Param[in] numOfEntries The selected new value.
@@ -821,7 +822,7 @@ t_Error FM_ConfigEnableCounters(t_Handle h_Fm);
@Description Define DMA debug counter.
Calling this routine changes the number of the DMA debug counter in the internal
- driver data base from its default configuration [e_FM_DMA_DBG_NO_CNT].
+ driver data base from its default configuration [DEFAULT_dmaDbgCntMode].
@Param[in] h_Fm A handle to an FM Module.
@Param[in] fmDmaDbgCntMode An enum selecting the debug counter mode.
@@ -840,7 +841,7 @@ t_Error FM_ConfigDmaDbgCounter(t_Handle h_Fm, e_FmDmaDbgCntMode fmDmaDbgCntMode)
@Description Define bus error behavior.
Calling this routine changes the bus error behavior definition
in the internal driver data base from its default
- configuration [FALSE].
+ configuration [DEFAULT_dmaStopOnBusError].
@Param[in] h_Fm A handle to an FM Module.
@Param[in] stop TRUE to stop on bus error, FALSE to continue.
@@ -879,7 +880,7 @@ t_Error FM_ConfigDmaEmergency(t_Handle h_Fm, t_FmDmaEmergency *p_Emergency);
@Description DMA error treatment.
Calling this routine changes the DMA error treatment
in the internal driver data base from its default
- configuration [e_FM_DMA_ERR_CATASTROPHIC].
+ configuration [DEFAULT_dmaErr].
@Param[in] h_Fm A handle to an FM Module.
@Param[in] dmaErr The selected new choice.
@@ -898,7 +899,7 @@ t_Error FM_ConfigDmaErr(t_Handle h_Fm, e_FmDmaErr dmaErr);
@Description Define FM behavior on catastrophic error.
Calling this routine changes the FM behavior on catastrophic
error in the internal driver data base from its default
- [e_FM_CATASTROPHIC_ERR_STALL_PORT].
+ [DEFAULT_catastrophicErr].
@Param[in] h_Fm A handle to an FM Module.
@Param[in] catastrophicErr The selected new choice.
@@ -953,7 +954,7 @@ t_Error FM_ConfigEnableIramTestMode(t_Handle h_Fm);
@Description Define FM behavior on external halt activation.
Calling this routine changes the FM behavior on external halt
activation in the internal driver data base from its default
- [FALSE].
+ [DEFAULT_haltOnExternalActivation].
@Param[in] h_Fm A handle to an FM Module.
@Param[in] enable TRUE to enable halt on external halt
@@ -973,7 +974,7 @@ t_Error FM_ConfigHaltOnExternalActivation(t_Handle h_Fm, bool enable);
@Description Define FM behavior on external halt activation.
Calling this routine changes the FM behavior on unrecoverable
ECC error in the internal driver data base from its default
- [FALSE].
+ [DEFAULT_haltOnUnrecoverableEccError].
This routine is only avaiable on old FM revisions (FMan v2).
@Param[in] h_Fm A handle to an FM Module.
@@ -1011,7 +1012,7 @@ t_Error FM_ConfigException(t_Handle h_Fm, e_FmExceptions exception, bool enable)
@Description Select external ECC enabling.
Calling this routine changes the ECC enabling control in the internal
- driver data base from its default [FALSE].
+ driver data base from its default [DEFAULT_externalEccRamsEnable].
When this option is enabled Rams ECC enabling is not effected
by FM_EnableRamsEcc/FM_DisableRamsEcc, but by a JTAG.
@@ -1030,9 +1031,9 @@ t_Error FM_ConfigExternalEccRamsEnable(t_Handle h_Fm, bool enable);
@Function FM_ConfigTnumAgingPeriod
@Description Define Tnum aging period.
- Calling this routine changes the Tnum aging of dequeue TNUM's
+ Calling this routine changes the Tnum aging of dequeue TNUMs
in the QMI in the internal driver data base from its default
- [0].
+ [DEFAULT_tnumAgingPeriod].
@Param[in] h_Fm A handle to an FM Module.
@Param[in] tnumAgingPeriod Tnum Aging Period in microseconds.
@@ -1045,6 +1046,8 @@ t_Error FM_ConfigExternalEccRamsEnable(t_Handle h_Fm, bool enable);
@Cautions Allowed only following FM_Config() and before FM_Init().
This routine should NOT be called from guest-partition
(i.e. guestId != NCSW_MASTER_ID)
+ NOTE that if some MAC is configured for PFC, '0' value is NOT
+ allowed.
*//***************************************************************************/
t_Error FM_ConfigTnumAgingPeriod(t_Handle h_Fm, uint16_t tnumAgingPeriod);
@@ -1073,15 +1076,15 @@ t_Error FM_ConfigDmaEmergencySmoother(t_Handle h_Fm, uint32_t emergencyCnt);
@Description Calling this routine changes the internal driver data base
from its default FM threshold configuration:
- dispLimit: [0]
- prsDispTh: [16]
- plcrDispTh: [16]
- kgDispTh: [16]
- bmiDispTh: [16]
- qmiEnqDispTh: [16]
- qmiDeqDispTh: [16]
- fmCtl1DispTh: [16]
- fmCtl2DispTh: [16]
+ dispLimit: [DEFAULT_dispLimit]
+ prsDispTh: [DEFAULT_prsDispTh]
+ plcrDispTh: [DEFAULT_plcrDispTh]
+ kgDispTh: [DEFAULT_kgDispTh]
+ bmiDispTh: [DEFAULT_bmiDispTh]
+ qmiEnqDispTh: [DEFAULT_qmiEnqDispTh]
+ qmiDeqDispTh: [DEFAULT_qmiDeqDispTh]
+ fmCtl1DispTh: [DEFAULT_fmCtl1DispTh]
+ fmCtl2DispTh: [DEFAULT_fmCtl2DispTh]
@Param[in] h_Fm A handle to an FM Module.
@@ -1099,7 +1102,7 @@ t_Error FM_ConfigThresholds(t_Handle h_Fm, t_FmThresholds *p_FmThresholds);
@Function FM_ConfigDmaSosEmergencyThreshold
@Description Calling this routine changes the internal driver data base
- from its default dma SOS emergency configuration [0]
+ from its default dma SOS emergency configuration [DEFAULT_dmaSosEmergency]
@Param[in] h_Fm A handle to an FM Module.
@Param[in] dmaSosEmergency The selected new value.
@@ -1117,8 +1120,8 @@ t_Error FM_ConfigDmaSosEmergencyThreshold(t_Handle h_Fm, uint32_t dmaSosEmergenc
@Description Calling this routine changes the internal driver data base
from its default configuration of DMA write buffer threshold
- assertEmergency: [DMA_THRESH_MAX_BUF]
- clearEmergency: [DMA_THRESH_MAX_BUF]
+ assertEmergency: [DEFAULT_dmaWriteIntBufLow]
+ clearEmergency: [DEFAULT_dmaWriteIntBufHigh]
This routine is only avaiable on old FM revisions (FMan v2).
@Param[in] h_Fm A handle to an FM Module.
@@ -1139,8 +1142,8 @@ t_Error FM_ConfigDmaWriteBufThresholds(t_Handle h_Fm, t_FmDmaThresholds *p_FmDma
@Description Calling this routine changes the internal driver data base
from its default configuration of DMA command queue threshold
- assertEmergency: [DMA_THRESH_MAX_COMMQ]
- clearEmergency: [DMA_THRESH_MAX_COMMQ]
+ assertEmergency: [DEFAULT_dmaCommQLow]
+ clearEmergency: [DEFAULT_dmaCommQHigh]
@Param[in] h_Fm A handle to an FM Module.
@Param[in] p_FmDmaThresholds A structure of thresholds to define emergency behavior -
@@ -1160,8 +1163,8 @@ t_Error FM_ConfigDmaCommQThresholds(t_Handle h_Fm, t_FmDmaThresholds *p_FmDmaThr
@Description Calling this routine changes the internal driver data base
from its default configuration of DMA read buffer threshold
- assertEmergency: [DMA_THRESH_MAX_BUF]
- clearEmergency: [DMA_THRESH_MAX_BUF]
+ assertEmergency: [DEFAULT_dmaReadIntBufLow]
+ clearEmergency: [DEFAULT_dmaReadIntBufHigh]
This routine is only avaiable on old FM revisions (FMan v2).
@Param[in] h_Fm A handle to an FM Module.
@@ -1182,7 +1185,7 @@ t_Error FM_ConfigDmaReadBufThresholds(t_Handle h_Fm, t_FmDmaThresholds *p_FmDmaT
@Description Calling this routine changes the internal driver data base
from its default watchdog configuration, which is disabled
- [0].
+ [DEFAULT_dmaWatchdog].
@Param[in] h_Fm A handle to an FM Module.
@Param[in] watchDogValue The selected new value - in microseconds.
diff --git a/drivers/net/ethernet/freescale/fman/inc/Peripherals/fm_mac_ext.h b/drivers/net/ethernet/freescale/fman/inc/Peripherals/fm_mac_ext.h
index 614622e..94b305c 100644
--- a/drivers/net/ethernet/freescale/fman/inc/Peripherals/fm_mac_ext.h
+++ b/drivers/net/ethernet/freescale/fman/inc/Peripherals/fm_mac_ext.h
@@ -101,6 +101,8 @@ typedef enum e_FmMacExceptions {
,e_FM_MAC_EX_1G_RX_DATA_ERR /**< dTSEC Internal data error on receive */
,e_FM_MAC_EX_1G_1588_TS_RX_ERR /**< dTSEC Time-Stamp Receive Error */
,e_FM_MAC_EX_1G_RX_MIB_CNT_OVFL /**< dTSEC MIB counter overflow */
+ ,e_FM_MAC_EX_TS_FIFO_ECC_ERR /**< mEMAC Time-stamp FIFO ECC error interrupt;
+ not supported on T4240/B4860 rev1 chips */
} e_FmMacExceptions;
/**************************************************************************//**
@@ -211,9 +213,14 @@ typedef struct t_FmMacParams {
uint8_t macId; /**< MAC ID <dTSEC 0-3> <10G-MAC 0> */
e_EnetMode enetMode; /**< Ethernet operation mode (MAC-PHY interface and speed);
Note that the speed should indicate the maximum rate that
- this MAC should support rather than the actuall speed;
+ this MAC should support rather than the actual speed;
i.e. user should use the FM_MAC_AdjustLink() routine to
provide accurate speed;
+ In case of mEMAC RGMII mode, the MAC is configured to RGMII
+ automatic mode, where actual speed/duplex mode information
+ is provided by PHY automatically in-band; FM_MAC_AdjustLink()
+ function should be used to switch to manual RGMII speed/duplex mode
+ configuration if RGMII PHY doesn't support in-band status signaling;
In addition, in mEMAC, in case where user is using the higher MACs
(i.e. the MACs that should support 10G), user should pass here
speed=10000 even if the interface is not allowing that (e.g. SGMII). */
@@ -283,7 +290,7 @@ t_Error FM_MAC_Free(t_Handle h_FmMac);
@Function FM_MAC_ConfigResetOnInit
@Description Tell the driver whether to reset the FM MAC before initialization or
- not. It changes the default configuration [FALSE].
+ not. It changes the default configuration [DEFAULT_resetOnInit].
@Param[in] h_FmMac A handle to a FM MAC Module.
@Param[in] enable When TRUE, FM will be reset before any initialization.
@@ -483,7 +490,7 @@ t_Error FM_MAC_Disable1588TimeStamp(t_Handle h_Fm);
@Function FM_MAC_SetTxAutoPauseFrames
@Description Enable/Disable transmission of Pause-Frames.
- The routine changes the default configuration [0xf000].
+ The routine changes the default configuration [DEFAULT_TX_PAUSE_TIME].
@Param[in] h_FmMac - A handle to a FM MAC Module.
@Param[in] pauseTime - Pause quanta value used with transmitted pause frames.
@@ -503,7 +510,7 @@ t_Error FM_MAC_SetTxAutoPauseFrames(t_Handle h_FmMac,
@Description Enable/Disable transmission of Pause-Frames.
The routine changes the default configuration:
- pause-time - [0xf000]
+ pause-time - [DEFAULT_TX_PAUSE_TIME]
threshold-time - [0]
@Param[in] h_FmMac - A handle to a FM MAC Module.
@@ -521,6 +528,9 @@ t_Error FM_MAC_SetTxAutoPauseFrames(t_Handle h_FmMac,
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_MAC_Init().
+ In order for PFC to work properly the user must configure
+ TNUM-aging in the tx-port it is recommended that pre-fetch and
+ rate limit in the tx port should be disabled;
PFC is supported only on new mEMAC; i.e. in MACs that don't have
PFC support (10G-MAC and dTSEC), user should use 'FM_MAC_NO_PFC'
in the 'priority' field.
@@ -699,12 +709,16 @@ t_Error FM_MAC_SetPromiscuous(t_Handle h_FmMac, bool enable);
@Function FM_MAC_AdjustLink
@Description Adjusts the Ethernet link with new speed/duplex setup.
- This routine is relevant only for dTSEC.
+ This routine is relevant for dTSEC and mEMAC.
+ In case of mEMAC, this routine is also used for manual
+ re-configuration of RGMII speed and duplex mode for
+ RGMII PHYs not supporting in-band status information
+ to MAC.
@Param[in] h_FmMac - A handle to a FM Module.
@Param[in] speed - Ethernet speed.
- @Param[in] fullDuplex - TRUE for Full-Duplex mode;
- FALSE for Half-Duplex mode.
+ @Param[in] fullDuplex - TRUE for full-duplex mode;
+ FALSE for half-duplex mode.
@Return E_OK on success; Error code otherwise.
*//***************************************************************************/
@@ -713,13 +727,13 @@ t_Error FM_MAC_AdjustLink(t_Handle h_FmMac, e_EnetSpeed speed, bool fullDuplex);
/**************************************************************************//**
@Function FM_MAC_RestartAutoneg
- @Description Restarts the autonegotiation process.
- When autonegegotiation process is invoked under traffic the
- autonegotiation process between the internal TBI PHY and the
- external PHY does not always complete succesfuly. Calling this
- function will restart the autonegotiation process that will end
- succesfuly. It is recomended to call this function after issuing
- autoneg restart command to the Eth Phy.
+ @Description Restarts the auto-negotiation process.
+ When auto-negotiation process is invoked under traffic the
+ auto-negotiation process between the internal SGMII PHY and the
+ external PHY does not always complete successfully. Calling this
+ function will restart the auto-negotiation process that will end
+ successfully. It is recommended to call this function after issuing
+ auto-negotiation restart command to the Eth Phy.
This routine is relevant only for dTSEC.
@Param[in] h_FmMac - A handle to a FM Module.
@@ -807,13 +821,5 @@ t_Error FM_MAC_DumpRegs(t_Handle h_FmMac);
/** @} */ /* end of FM_mac_grp group */
/** @} */ /* end of FM_grp group */
-/**************************************************************************//**
- @Function DtsecRestartTbiAN
-
- @Description Restart TBI autonegotiation for a given Dtsec TBI interface.
-
- @Param[in] h_Dtsec - A handle to the Dtsec.
-*//***************************************************************************/
-void DtsecRestartTbiAN(t_Handle h_Dtsec);
#endif /* __FM_MAC_EXT_H */
diff --git a/drivers/net/ethernet/freescale/fman/inc/Peripherals/fm_pcd_ext.h b/drivers/net/ethernet/freescale/fman/inc/Peripherals/fm_pcd_ext.h
index f4dfd63..60edfd2 100644
--- a/drivers/net/ethernet/freescale/fman/inc/Peripherals/fm_pcd_ext.h
+++ b/drivers/net/ethernet/freescale/fman/inc/Peripherals/fm_pcd_ext.h
@@ -66,7 +66,7 @@
and the policer global and common registers.
In addition, the FM PCD SW module will initialize all required
key generator schemes, coarse classification flows, and policer
- profiles. When a FM module is configured to work with one of these
+ profiles. When FM module is configured to work with one of these
entities, it will register to it using the FM PORT API. The PCD
module will manage the PCD resources - i.e. resource management of
KeyGen schemes, etc.
@@ -275,8 +275,6 @@ typedef struct t_FmPcdParams {
*//***************************************************************************/
t_Handle FM_PCD_Config(t_FmPcdParams *p_FmPcdParams);
-t_Handle FM_PCD_GetHcDevH(t_Handle h_FmPcd);
-
/**************************************************************************//**
@Function FM_PCD_Init
@@ -314,7 +312,7 @@ t_Error FM_PCD_Free(t_Handle h_FmPcd);
@Description Calling this routine changes the internal driver data base
from its default selection of exceptions enabling.
- [4].
+ [DEFAULT_numOfSharedPlcrProfiles].
@Param[in] h_FmPcd FM PCD module descriptor.
@Param[in] exception The exception to be selected.
@@ -349,7 +347,7 @@ t_Error FM_PCD_ConfigHcFramesDataMemory(t_Handle h_FmPcd, uint8_t memId);
@Description Calling this routine changes the internal driver data base
from its default selection of exceptions enablement.
- [4].
+ [DEFAULT_numOfSharedPlcrProfiles].
@Param[in] h_FmPcd FM PCD module descriptor.
@Param[in] numOfSharedPlcrProfiles Number of profiles to
@@ -364,7 +362,7 @@ t_Error FM_PCD_ConfigPlcrNumOfSharedProfiles(t_Handle h_FmPcd, uint16_t numOfSha
@Description Calling this routine changes the internal driver data base
from its default selection of exceptions enablement.
- By default auto-refresh is [disabled].
+ By default auto-refresh is [DEFAULT_plcrAutoRefresh].
@Param[in] h_FmPcd FM PCD module descriptor.
@Param[in] enable TRUE to enable, FALSE to disable
@@ -381,7 +379,7 @@ t_Error FM_PCD_ConfigPlcrAutoRefreshMode(t_Handle h_FmPcd, bool enable);
@Description Calling this routine changes the internal data structure for
the maximum parsing time from its default value
- [0].
+ [DEFAULT_MAX_PRS_CYC_LIM].
@Param[in] h_FmPcd FM PCD module descriptor.
@Param[in] value 0 to disable the mechanism, or new
@@ -812,7 +810,6 @@ t_Error FM_PCD_HcDumpRegs(t_Handle h_FmPcd);
#define FM_PCD_MAX_SIZE_OF_KEY 56
#define FM_PCD_MAX_NUM_OF_CC_ENTRIES_IN_GRP 16
#define FM_PCD_LAST_KEY_INDEX 0xffff
-#define FM_PCD_MANIP_DSCP_VALUES 64
#define FM_PCD_MAX_NUM_OF_CC_NODES 255 /* Obsolete, not used - will be removed in the future */
/* @} */
@@ -1342,7 +1339,6 @@ typedef union u_FmPcdHdrProtocolOpt {
NET_HEADER_FIELD_UDP_PORT_SRC
NET_HEADER_FIELD_UDP_PORT_DST
-
HEADER_TYPE_UDP_LITE: - relevant only if FM_CAPWAP_SUPPORT define
NET_HEADER_FIELD_UDP_LITE_PORT_SRC
NET_HEADER_FIELD_UDP_LITE_PORT_DST
@@ -1937,6 +1933,8 @@ typedef struct t_FmPcdHashTableParams {
uint16_t maxNumOfKeys; /**< Maximum Number Of Keys that will (ever) be used in this Hash-table */
e_FmPcdCcStatsMode statisticsMode; /**< If not e_FM_PCD_CC_STATS_MODE_NONE, the required structures for the
requested statistics mode will be allocated according to maxNumOfKeys. */
+ uint8_t kgHashShift; /**< KG-Hash-shift as it was configured in the KG-scheme
+ that leads to this hash-table. */
uint16_t hashResMask; /**< Mask that will be used on the hash-result;
The number-of-sets for this hash will be calculated
as (2^(number of bits set in 'hashResMask'));
@@ -2260,7 +2258,7 @@ typedef struct t_FmPcdManipReassemIpParams {
relativeSchemeId[1] - Relative scheme ID for IPV6 Reassembly manipulation;
NOTE: The following comment is relevant only for FMAN v2 devices:
Relative scheme ID for IPv4/IPv6 Reassembly manipulation must be smaller than
- the user schemes id to ensure that the reassembly's schemes will be first match;
+ the user schemes id to ensure that the reassembly schemes will be first match;
Rest schemes, if defined, should have higher relative scheme ID. */
#if (DPAA_VERSION >= 11)
uint32_t nonConsistentSpFqid; /**< In case that other fragments of the frame corresponds to different storage
@@ -2286,7 +2284,8 @@ typedef struct t_FmPcdManipReassemIpParams {
In the case numOfFramesPerHashEntry == e_FM_PCD_MANIP_EIGHT_WAYS_HASH,
maxNumFramesInProcess has to be in the range of 8 - 2048. */
e_FmPcdManipReassemTimeOutMode timeOutMode; /**< Expiration delay initialized by Reassembly process */
- uint32_t fqidForTimeOutFrames; /**< FQID in which time out frames will enqueue during Time Out Process */
+ uint32_t fqidForTimeOutFrames; /**< FQID in which time out frames will enqueue during Time Out Process;
+ Recommended value for this field is 0; in this way timed-out frames will be discarded */
uint32_t timeoutThresholdForReassmProcess;
/**< Represents the time interval in microseconds which defines
if opened frame (at least one fragment was processed but not all the fragments)is found as too old*/
@@ -2583,6 +2582,10 @@ typedef struct t_FmPcdManipReassemIpStats {
uint32_t externalBufferBusy; /**< Counts the number of times external buffer busy occurred */
uint32_t sgFragments; /**< Counts the number of Scatter/Gather fragments */
uint32_t dmaSemaphoreDepletion; /**< Counts the number of failed attempts to allocate a DMA semaphore */
+#if (DPAA_VERSION >= 11)
+ uint32_t nonConsistentSp; /**< Counts the number of Non Consistent Storage Profile events for
+ successfully reassembled frames */
+#endif /* (DPAA_VERSION >= 11) */
struct {
uint32_t successfullyReassembled; /**< Counts the number of successfully reassembled frames */
uint32_t validFragments; /**< Counts the total number of valid fragments that
@@ -3588,6 +3591,8 @@ t_Handle FM_PCD_StatisticsSetNode(t_Handle h_FmPcd, t_FmPcdStatsParams *p_FmPcds
#define e_FM_PCD_MANIP_ONE_WAYS_HASH e_FM_PCD_MANIP_ONE_WAY_HASH
#define e_FM_PCD_MANIP_TOW_WAYS_HASH e_FM_PCD_MANIP_TWO_WAYS_HASH
+#define e_FM_PCD_MANIP_FRAGMENT_PACKECT e_FM_PCD_MANIP_FRAGMENT_PACKET /* Feb13 */
+
#define FM_PCD_SetNetEnvCharacteristics(_pcd, _params) \
FM_PCD_NetEnvCharacteristicsSet(_pcd, _params)
#define FM_PCD_KgSetScheme(_pcd, _params) FM_PCD_KgSchemeSet(_pcd, _params)
diff --git a/drivers/net/ethernet/freescale/fman/inc/Peripherals/fm_port_ext.h b/drivers/net/ethernet/freescale/fman/inc/Peripherals/fm_port_ext.h
index afa2cd9..89fabbc 100644
--- a/drivers/net/ethernet/freescale/fman/inc/Peripherals/fm_port_ext.h
+++ b/drivers/net/ethernet/freescale/fman/inc/Peripherals/fm_port_ext.h
@@ -504,8 +504,8 @@ t_Error FM_PORT_ConfigSizeOfFifo(t_Handle h_FmPort, t_FmPortRsrc *p_SizeOfFifo);
@Description Calling this routine changes the dequeue priority in the
internal driver data base from its default configuration
- 1G: [FALSE]
- 10G: [TRUE]
+ 1G: [DEFAULT_PORT_deqHighPriority_1G]
+ 10G: [DEFAULT_PORT_deqHighPriority_10G]
May be used for Non-Rx ports only
@@ -523,7 +523,7 @@ t_Error FM_PORT_ConfigDeqHighPriority(t_Handle h_FmPort, bool highPri);
@Description Calling this routine changes the dequeue type parameter in the
internal driver data base from its default configuration
- [e_FM_PORT_DEQ_TYPE1].
+ [DEFAULT_PORT_deqType].
May be used for Non-Rx ports only
@@ -541,7 +541,7 @@ t_Error FM_PORT_ConfigDeqType(t_Handle h_FmPort, e_FmPortDeqType deqType);
@Description Calling this routine changes the dequeue prefetch option parameter in the
internal driver data base from its default configuration
- [e_FM_PORT_DEQ_FULL_PREFETCH]
+ [DEFAULT_PORT_deqPrefetchOption]
Note: Available for some chips only
May be used for Non-Rx ports only
@@ -560,8 +560,8 @@ t_Error FM_PORT_ConfigDeqPrefetchOption(t_Handle h_FmPort, e_FmPortDeqPrefetchOp
@Description Calling this routine changes the dequeue byte count parameter in
the internal driver data base from its default configuration
- 1G:[0x400].
- 10G:[0x1400].
+ 1G:[DEFAULT_PORT_deqByteCnt_1G].
+ 10G:[DEFAULT_PORT_deqByteCnt_10G].
May be used for Non-Rx ports only
@@ -587,9 +587,9 @@ t_Error FM_PORT_ConfigDeqByteCnt(t_Handle h_FmPort, uint16_t deqByteCnt);
application buffer, and to offset.
Calling this routine changes the buffer margins definitions
in the internal driver data base from its default
- configuration: Data size: [DEFAULT_FM_SP_bufferPrefixContent_privDataSize]
- Pass Parser result: [DEFAULT_FM_SP_bufferPrefixContent_passPrsResult].
- Pass timestamp: [DEFAULT_FM_SP_bufferPrefixContent_passTimeStamp].
+ configuration: Data size: [DEFAULT_PORT_bufferPrefixContent_privDataSize]
+ Pass Parser result: [DEFAULT_PORT_bufferPrefixContent_passPrsResult].
+ Pass timestamp: [DEFAULT_PORT_bufferPrefixContent_passTimeStamp].
May be used for all ports
@@ -611,7 +611,7 @@ t_Error FM_PORT_ConfigBufferPrefixContent(t_Handle h_FmPort
@Description Calling this routine changes the number of checksum bytes to ignore
parameter in the internal driver data base from its default configuration
- [0]
+ [DEFAULT_PORT_cheksumLastBytesIgnore]
May be used by Tx & Rx ports only
@@ -629,7 +629,7 @@ t_Error FM_PORT_ConfigCheksumLastBytesIgnore(t_Handle h_FmPort, uint8_t cheksumL
@Description Calling this routine changes the number of bytes to cut from a
frame's end parameter in the internal driver data base
- from its default configuration [4]
+ from its default configuration [DEFAULT_PORT_cutBytesFromEnd]
Note that if the result of (frame length before chop - cutBytesFromEnd) is
less than 14 bytes, the chop operation is not executed.
@@ -730,7 +730,7 @@ t_Error FM_PORT_ConfigBackupPools(t_Handle h_FmPort, t_FmBackupBmPools *p_FmPort
@Description Calling this routine changes the error frames destination parameter
in the internal driver data base from its default configuration:
- override = [FALSE]
+ override = [DEFAULT_PORT_frmDiscardOverride]
May be used for Rx and OP ports only
@@ -749,7 +749,7 @@ t_Error FM_PORT_ConfigFrmDiscardOverride(t_Handle h_FmPort, bool override);
@Description Calling this routine changes the behaviour on error parameter
in the internal driver data base from its default configuration:
- [FM_PORT_FRM_ERR_CLS_DISCARD].
+ [DEFAULT_PORT_errorsToDiscard].
If a requested error was previously defined as "ErrorsToEnqueue" it's
definition will change and the frame will be discarded.
Errors that were not defined either as "ErrorsToEnqueue" nor as
@@ -771,7 +771,7 @@ t_Error FM_PORT_ConfigErrorsToDiscard(t_Handle h_FmPort, fmPortFrameErrSelect_t
@Description Calling this routine changes the DMA swap data aparameter
in the internal driver data base from its default
- configuration [DEFAULT_FM_SP_dmaSwapData]
+ configuration [DEFAULT_PORT_dmaSwapData]
May be used for all port types
@@ -789,7 +789,7 @@ t_Error FM_PORT_ConfigDmaSwapData(t_Handle h_FmPort, e_FmDmaSwapOption swapData)
@Description Calling this routine changes the internal context cache
attribute parameter in the internal driver data base
- from its default configuration [DEFAULT_FM_SP_dmaIntContextCacheAttr]
+ from its default configuration [DEFAULT_PORT_dmaIntContextCacheAttr]
May be used for all port types
@@ -807,7 +807,7 @@ t_Error FM_PORT_ConfigDmaIcCacheAttr(t_Handle h_FmPort, e_FmDmaCacheOption intCo
@Description Calling this routine changes the header cache
attribute parameter in the internal driver data base
- from its default configuration [DEFAULT_FM_SP_dmaHeaderCacheAttr]
+ from its default configuration [DEFAULT_PORT_dmaHeaderCacheAttr]
May be used for all port types
@@ -825,7 +825,7 @@ t_Error FM_PORT_ConfigDmaHdrAttr(t_Handle h_FmPort, e_FmDmaCacheOption headerCac
@Description Calling this routine changes the scatter gather cache
attribute parameter in the internal driver data base
- from its default configuration [DEFAULT_FM_SP_dmaScatterGatherCacheAttr]
+ from its default configuration [DEFAULT_PORT_dmaScatterGatherCacheAttr]
May be used for all port types
@@ -843,7 +843,7 @@ t_Error FM_PORT_ConfigDmaScatterGatherAttr(t_Handle h_FmPort, e_FmDmaCacheOption
@Description Calling this routine changes the write optimization
parameter in the internal driver data base
- from its default configuration: By default optimize = [DEFAULT_FM_SP_dmaWriteOptimize].
+ from its default configuration: By default optimize = [DEFAULT_PORT_dmaWriteOptimize].
Note:
1. For head optimization, data alignment must be >= 16 (supported by default).
@@ -852,7 +852,6 @@ t_Error FM_PORT_ConfigDmaScatterGatherAttr(t_Handle h_FmPort, e_FmDmaCacheOption
of the frame payload at the tail as needed to achieve optimal bus transfers, so that the last write
is extended to be on 16/64 bytes aligned block (chip dependent).
-
Relevant for non-Tx port types
@Param[in] h_FmPort A handle to a FM Port module.
@@ -885,7 +884,7 @@ t_Error FM_PORT_ConfigNoScatherGather(t_Handle h_FmPort, bool noScatherGather);
@Description Calling this routine changes the internal default color parameter
in the internal driver data base
- from its default configuration [e_FM_PORT_COLOR_GREEN]
+ from its default configuration [DEFAULT_PORT_color]
May be used for all port types
@@ -903,7 +902,7 @@ t_Error FM_PORT_ConfigDfltColor(t_Handle h_FmPort, e_FmPortColor color);
@Description Calling this routine changes the synchronization attribute parameter
in the internal driver data base from its default configuration:
- syncReq = [TRUE]
+ syncReq = [DEFAULT_PORT_syncReq]
May be used for all port types
@@ -922,7 +921,7 @@ t_Error FM_PORT_ConfigSyncReq(t_Handle h_FmPort, bool syncReq);
@Description This routine is relevant for Rx ports that are routed to OP port.
It changes the internal context reuse option in the internal
driver data base from its default configuration:
- reuse = [FALSE]
+ reuse = [DEFAULT_PORT_forwardIntContextReuse]
May be used for Rx ports only
@@ -988,7 +987,7 @@ t_Error FM_PORT_ConfigIMMaxRxBufLength(t_Handle h_FmPort, uint16_t newVal);
@Function FM_PORT_ConfigIMRxBdRingLength
@Description Changes the receive BD ring length from its default
- configuration:[128]
+ configuration:[DEFAULT_PORT_rxBdRingLength]
@Param[in] h_FmPort A handle to a FM Port module.
@Param[in] newVal The desired BD ring length.
@@ -1004,7 +1003,7 @@ t_Error FM_PORT_ConfigIMRxBdRingLength(t_Handle h_FmPort, uint16_t newVal);
@Function FM_PORT_ConfigIMTxBdRingLength
@Description Changes the transmit BD ring length from its default
- configuration:[16]
+ configuration:[DEFAULT_PORT_txBdRingLength]
@Param[in] h_FmPort A handle to a FM Port module.
@Param[in] newVal The desired BD ring length.
@@ -1023,7 +1022,7 @@ t_Error FM_PORT_ConfigIMTxBdRingLength(t_Handle h_FmPort, uint16_t newVal);
data structures (e.g. BD rings).
Calling this routine changes the internal driver data base
from its default configuration
- [0, MEMORY_ATTR_CACHEABLE].
+ [DEFAULT_PORT_ImfwExtStructsMemId, DEFAULT_PORT_ImfwExtStructsMemAttr].
@Param[in] h_FmPort A handle to a FM Port module.
@Param[in] memId Memory partition ID.
@@ -1053,7 +1052,7 @@ t_Error FM_PORT_ConfigIMPolling(t_Handle h_FmPort);
@Function FM_PORT_ConfigMaxFrameLength
@Description Changes the definition of the max size of frame that should be
- transmitted/received on this port from its default value [9600].
+ transmitted/received on this port from its default value [DEFAULT_PORT_maxFrameLength].
This parameter is used for confirmation of the minimum Fifo
size calculations and only for Tx ports or ports working in
independent mode. This should be larger than the maximum possible
@@ -1074,7 +1073,7 @@ t_Error FM_PORT_ConfigMaxFrameLength(t_Handle h_FmPort, uint16_t length);
@Description Calling this routine changes the fifo minimum
fill level parameter in the internal driver data base
- from its default configuration [0]
+ from its default configuration [DEFAULT_PORT_txFifoMinFillLevel]
May be used for Tx ports only
@@ -1093,8 +1092,8 @@ t_Error FM_PORT_ConfigTxFifoMinFillLevel(t_Handle h_FmPort, uint32_t minFillLeve
@Description Calling this routine changes the fifo dequeue
pipeline depth parameter in the internal driver data base
- from its default configuration: 1G ports: [1],
- 10G port: [4]
+ from its default configuration: 1G ports: [DEFAULT_PORT_fifoDeqPipelineDepth_1G],
+ 10G port: [DEFAULT_PORT_fifoDeqPipelineDepth_10G]
May be used for Tx ports only
@@ -1112,7 +1111,7 @@ t_Error FM_PORT_ConfigFifoDeqPipelineDepth(t_Handle h_FmPort, uint8_t deqPipelin
@Description Calling this routine changes the fifo low comfort level
parameter in internal driver data base
- from its default configuration [5]
+ from its default configuration [DEFAULT_PORT_txFifoLowComfLevel]
May be used for Tx ports only
@@ -1130,7 +1129,7 @@ t_Error FM_PORT_ConfigTxFifoLowComfLevel(t_Handle h_FmPort, uint32_t fifoLowComf
@Description Calling this routine changes the threshold of the FIFO
fill level parameter in the internal driver data base
- from its default configuration [BMI_MAX_FIFO_SIZE]
+ from its default configuration [DEFAULT_PORT_rxFifoThreshold]
If the total number of buffers which are
currently in use and associated with the
@@ -1154,7 +1153,7 @@ t_Error FM_PORT_ConfigRxFifoThreshold(t_Handle h_FmPort, uint32_t fifoThreshold)
@Description Calling this routine changes the priority elevation level
parameter in the internal driver data base from its default
- configuration [BMI_MAX_FIFO_SIZE]
+ configuration [DEFAULT_PORT_rxFifoPriElevationLevel]
If the total number of buffers which are currently in use and
associated with the specific RX port exceed the amount specified
@@ -1427,6 +1426,8 @@ t_Error FM_PORT_Enable(t_Handle h_FmPort);
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PORT_Init().
+ If rate limit is set on a port that need to send PFC frames,
+ it might violate the stop transmit timing.
*//***************************************************************************/
t_Error FM_PORT_SetRateLimit(t_Handle h_FmPort, t_FmPortRateLimit *p_RateLimit);
@@ -1447,6 +1448,24 @@ t_Error FM_PORT_SetRateLimit(t_Handle h_FmPort, t_FmPortRateLimit *p_RateLimit);
t_Error FM_PORT_DeleteRateLimit(t_Handle h_FmPort);
/**************************************************************************//**
+ @Function FM_PORT_SetPfcPrioritiesMappingToQmanWQ
+
+ @Description Calling this routine maps each PFC received priority to the transmit WQ.
+ This WQ will be blocked upon receiving a PFC frame with this priority.
+
+ May be used for Tx ports only.
+
+ @Param[in] h_FmPort A handle to a FM Port module.
+ @Param[in] prio PFC priority (0-7).
+ @Param[in] wq Work Queue (0-7).
+
+ @Return E_OK on success; Error code otherwise.
+
+ @Cautions Allowed only following FM_PORT_Init().
+*//***************************************************************************/
+t_Error FM_PORT_SetPfcPrioritiesMappingToQmanWQ(t_Handle h_FmPort, uint8_t prio, uint8_t wq);
+
+/**************************************************************************//**
@Function FM_PORT_SetStatisticsCounters
@Description Calling this routine enables/disables port's statistics counters.
@@ -1926,7 +1945,7 @@ typedef struct t_FmPcdPrsStart {
@Description struct for defining external buffer margins
*//***************************************************************************/
typedef struct t_FmPortVSPAllocParams {
- uint8_t numOfProfiles; /**< Number of Virtual Storage Profiles */
+ uint8_t numOfProfiles; /**< Number of Virtual Storage Profiles; must be a power of 2 */
uint8_t dfltRelativeId; /**< The default Virtual-Storage-Profile-id dedicated to Rx/OP port
The same default Virtual-Storage-Profile-id will be for coupled Tx port
if relevant function called for Rx port */
@@ -2053,7 +2072,7 @@ t_Error FM_PORT_PcdPlcrFreeProfiles(t_Handle h_FmPort);
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PORT_Init(), and before FM_PORT_SetPCD()
- and also before FM_PORT_Enable() (i.e. the port should be disabled).
+ and also before FM_PORT_Enable(); i.e. the port should be disabled.
*//***************************************************************************/
t_Error FM_PORT_VSPAlloc(t_Handle h_FmPort, t_FmPortVSPAllocParams *p_Params);
#endif /* (DPAA_VERSION >= 11) */
diff --git a/drivers/net/ethernet/freescale/fman/inc/Peripherals/fm_rtc_ext.h b/drivers/net/ethernet/freescale/fman/inc/Peripherals/fm_rtc_ext.h
index c8fa262..315405c 100644
--- a/drivers/net/ethernet/freescale/fman/inc/Peripherals/fm_rtc_ext.h
+++ b/drivers/net/ethernet/freescale/fman/inc/Peripherals/fm_rtc_ext.h
@@ -45,7 +45,7 @@
#include "error_ext.h"
#include "std_ext.h"
-
+#include "fsl_fman_rtc.h"
/**************************************************************************//**
@@ -77,8 +77,8 @@
*//***************************************************************************/
typedef enum e_FmRtcAlarmPolarity
{
- e_FM_RTC_ALARM_POLARITY_ACTIVE_HIGH, /**< Active-high output polarity */
- e_FM_RTC_ALARM_POLARITY_ACTIVE_LOW /**< Active-low output polarity */
+ e_FM_RTC_ALARM_POLARITY_ACTIVE_HIGH = E_FMAN_RTC_ALARM_POLARITY_ACTIVE_HIGH, /**< Active-high output polarity */
+ e_FM_RTC_ALARM_POLARITY_ACTIVE_LOW = E_FMAN_RTC_ALARM_POLARITY_ACTIVE_LOW /**< Active-low output polarity */
} e_FmRtcAlarmPolarity;
/**************************************************************************//**
@@ -86,8 +86,8 @@ typedef enum e_FmRtcAlarmPolarity
*//***************************************************************************/
typedef enum e_FmRtcTriggerPolarity
{
- e_FM_RTC_TRIGGER_ON_RISING_EDGE, /**< Trigger on rising edge */
- e_FM_RTC_TRIGGER_ON_FALLING_EDGE /**< Trigger on falling edge */
+ e_FM_RTC_TRIGGER_ON_RISING_EDGE = E_FMAN_RTC_TRIGGER_ON_RISING_EDGE, /**< Trigger on rising edge */
+ e_FM_RTC_TRIGGER_ON_FALLING_EDGE = E_FMAN_RTC_TRIGGER_ON_FALLING_EDGE /**< Trigger on falling edge */
} e_FmRtcTriggerPolarity;
/**************************************************************************//**
@@ -95,9 +95,9 @@ typedef enum e_FmRtcTriggerPolarity
*//***************************************************************************/
typedef enum e_FmSrcClock
{
- e_FM_RTC_SOURCE_CLOCK_EXTERNAL, /**< external high precision timer reference clock */
- e_FM_RTC_SOURCE_CLOCK_SYSTEM, /**< MAC system clock */
- e_FM_RTC_SOURCE_CLOCK_OSCILATOR /**< RTC clock oscilator */
+ e_FM_RTC_SOURCE_CLOCK_EXTERNAL = E_FMAN_RTC_SOURCE_CLOCK_EXTERNAL, /**< external high precision timer reference clock */
+ e_FM_RTC_SOURCE_CLOCK_SYSTEM = E_FMAN_RTC_SOURCE_CLOCK_SYSTEM, /**< MAC system clock */
+ e_FM_RTC_SOURCE_CLOCK_OSCILATOR = E_FMAN_RTC_SOURCE_CLOCK_OSCILATOR /**< RTC clock oscilator */
}e_FmSrcClk;
/**************************************************************************//**
@@ -170,7 +170,7 @@ t_Error FM_RTC_Free(t_Handle h_FmRtc);
@Function FM_RTC_ConfigPeriod
@Description Configures the period of the timestamp if different than
- default [1000].
+ default [DEFAULT_clockPeriod].
@Param[in] h_FmRtc - Handle to FM RTC object.
@Param[in] period - Period in nano-seconds.
@@ -202,7 +202,7 @@ t_Error FM_RTC_ConfigSourceClock(t_Handle h_FmRtc,
@Function FM_RTC_ConfigPulseRealignment
@Description Configures the RTC to automatic FIPER pulse realignment in
- response to timer adjustments [FALSE]
+ response to timer adjustments [DEFAULT_pulseRealign]
In this mode, the RTC clock is identical to the source clock.
This feature can be useful when the system contains an external
@@ -221,7 +221,7 @@ t_Error FM_RTC_ConfigPulseRealignment(t_Handle h_FmRtc, bool enable);
@Function FM_RTC_ConfigFrequencyBypass
@Description Configures the RTC to bypass the frequency compensation
- mechanism. [FALSE]
+ mechanism. [DEFAULT_bypass]
In this mode, the RTC clock is identical to the source clock.
This feature can be useful when the system contains an external
@@ -241,7 +241,7 @@ t_Error FM_RTC_ConfigFrequencyBypass(t_Handle h_FmRtc, bool enabled);
@Function FM_RTC_ConfigInvertedInputClockPhase
@Description Configures the RTC to invert the source clock phase on input.
- [FALSE]
+ [DEFAULT_invertInputClkPhase]
@Param[in] h_FmRtc - Handle to FM RTC object.
@Param[in] inverted - TRUE to invert the source clock phase on input.
@@ -257,7 +257,7 @@ t_Error FM_RTC_ConfigInvertedInputClockPhase(t_Handle h_FmRtc, bool inverted);
@Function FM_RTC_ConfigInvertedOutputClockPhase
@Description Configures the RTC to invert the output clock phase.
- [FALSE]
+ [DEFAULT_invertOutputClkPhase]
@Param[in] h_FmRtc - Handle to FM RTC object.
@Param[in] inverted - TRUE to invert the output clock phase.
@@ -273,7 +273,7 @@ t_Error FM_RTC_ConfigInvertedOutputClockPhase(t_Handle h_FmRtc, bool inverted);
@Function FM_RTC_ConfigOutputClockDivisor
@Description Configures the divisor for generating the output clock from
- the RTC clock. [0x00000002]
+ the RTC clock. [DEFAULT_outputClockDivisor]
@Param[in] h_FmRtc - Handle to FM RTC object.
@Param[in] divisor - Divisor for generation of the output clock.
@@ -288,7 +288,7 @@ t_Error FM_RTC_ConfigOutputClockDivisor(t_Handle h_FmRtc, uint16_t divisor);
@Function FM_RTC_ConfigAlarmPolarity
@Description Configures the polarity (active-high/active-low) of a specific
- alarm signal. [e_FM_RTC_ALARM_POLARITY_ACTIVE_HIGH]
+ alarm signal. [DEFAULT_alarmPolarity]
@Param[in] h_FmRtc - Handle to FM RTC object.
@Param[in] alarmId - Alarm ID.
@@ -306,7 +306,7 @@ t_Error FM_RTC_ConfigAlarmPolarity(t_Handle h_FmRtc,
@Function FM_RTC_ConfigExternalTriggerPolarity
@Description Configures the polarity (rising/falling edge) of a specific
- external trigger signal. [e_FM_RTC_TRIGGER_ON_FALLING_EDGE]
+ external trigger signal. [DEFAULT_triggerPolarity]
@Param[in] h_FmRtc - Handle to FM RTC object.
@Param[in] triggerId - Trigger ID.