Functions
SERDES HYPERLINK

Functions

CSL_IDEF_INLINE CSL_SERDES_RESULT CSL_HyperlinkSerdesInit (uint32_t base_addr, CSL_SERDES_REF_CLOCK ref_clock, CSL_SERDES_LINK_RATE rate)
CSL_IDEF_INLINE void CSL_HyperlinkSerdesLaneConfig (uint32_t base_addr, CSL_SERDES_REF_CLOCK ref_clock, CSL_SERDES_LINK_RATE rate, uint32_t lane_num)
CSL_IDEF_INLINE void CSL_HyperlinkSerdesComEnable (uint32_t base_addr)
CSL_IDEF_INLINE void CSL_HyperlinkSerdesLaneEnable (uint32_t base_addr, uint32_t lane_num, CSL_SERDES_LOOPBACK loopback_mode, CSL_SERDES_LANE_CTRL_RATE lane_ctrl_rate)
CSL_IDEF_INLINE void CSL_HyperlinkSerdesLaneDisable (uint32_t base_addr, uint32_t lane_num)
CSL_IDEF_INLINE void CSL_HyperlinkSerdesLaneReset (uint32_t base_addr, uint32_t lane_num)
CSL_IDEF_INLINE void CSL_HyperlinkSerdesPllEnable (uint32_t base_addr)
CSL_IDEF_INLINE CSL_SERDES_STATUS CSL_HyperlinkSerdesGetStatus (uint32_t base_addr, uint32_t num_lanes)
CSL_IDEF_INLINE CSL_SERDES_STATUS CSL_HyperlinkSerdesGetPLLStatus (uint32_t base_addr)
CSL_IDEF_INLINE CSL_SERDES_STATUS CSL_HyperlinkSerdesGetLaneStatus (uint32_t base_addr, uint32_t lane_num)
CSL_IDEF_INLINE void CSL_HyperlinkSerdesShutdown (uint32_t base_addr)

Detailed Description

============================================================================

Introduction

Overview

This module deals with setting up SERDES configuration for HYPERLINK. The API flow should be as follows:

CSL_HyperlinkSerdesInit (base_addr, ref_clock, rate);

CSL_HyperlinkSerdesLaneConfig (base_addr, ref_clock, rate, lane_num);

CSL_HyperlinkSerdesComEnable (base_addr);

CSL_HyperlinkSerdesLaneEnable (base_addr, lane_num, link_rate, loopback_mode, lane_ctrl_rate);

CSL_HyperlinkSerdesPllEnable (base_addr);

CSL_HyperlinkSerdesGetStatus (base_addr, num_lanes);

OR

CSL_HyperlinkSerdesGetPLLStatus (base_addr);

CSL_HyperlinkSerdesGetLaneStatus (base_addr, lane_num); //Individual lane status

References

============================================================================


Function Documentation

CSL_IDEF_INLINE void CSL_HyperlinkSerdesComEnable ( uint32_t  base_addr)

============================================================================
CSL_HyperlinkSerdesComEnable

Description
This API is currently deprecated and the functionality is integrated into CSL_HyperlinkSerdesInit API. It is currently used for backwards compatibility.

Arguments base_addr

Return Value None

Pre Condition
None

Post Condition
None

Reads
None

Usage Constraints:
None

Example

 
     CSL_HyperlinkSerdesComEnable(CSL_HYPERLINK_0_SERDES_CFG_REGS);

    

===========================================================================

CSL_IDEF_INLINE CSL_SERDES_STATUS CSL_HyperlinkSerdesGetLaneStatus ( uint32_t  base_addr,
uint32_t  lane_num 
)

============================================================================
CSL_HyperlinkSerdesGetLaneStatus

Description
This API returns the status of the Lanes

Arguments base_addr, lane_num

Return Value CSL_SERDES_STATUS

Pre Condition
None

Post Condition
None

Reads
None

Usage Constraints:
None

Example

 
     CSL_HyperlinkSerdesGetLaneStatus(CSL_HYPERLINK_0_SERDES_CFG_REGS, 0);

    

===========================================================================

CSL_IDEF_INLINE CSL_SERDES_STATUS CSL_HyperlinkSerdesGetPLLStatus ( uint32_t  base_addr)

============================================================================
CSL_HyperlinkSerdesGetPLLStatus

Description
This API returns the status of the PLL lock

Arguments base_addr

Return Value CSL_SERDES_STATUS

Pre Condition
None

Post Condition
None

Reads
None

Usage Constraints:
None

Example

 
     CSL_HyperlinkSerdesGetPLLStatus(CSL_HYPERLINK_0_SERDES_CFG_REGS);

    

===========================================================================

CSL_IDEF_INLINE CSL_SERDES_STATUS CSL_HyperlinkSerdesGetStatus ( uint32_t  base_addr,
uint32_t  num_lanes 
)

============================================================================
CSL_HyperlinkSerdesGetStatus

Description
This API returns the status of the PLL lock

Arguments base_addr, num_lanes

Return Value CSL_SERDES_STATUS

Pre Condition
None

Post Condition
None

Reads
None

Usage Constraints:
None

Example

 
     CSL_HyperlinkSerdesGetStatus(CSL_HYPERLINK_0_SERDES_CFG_REGS, 4);

    

===========================================================================

CSL_IDEF_INLINE CSL_SERDES_RESULT CSL_HyperlinkSerdesInit ( uint32_t  base_addr,
CSL_SERDES_REF_CLOCK  ref_clock,
CSL_SERDES_LINK_RATE  rate 
)

============================================================================
CSL_HyperlinkSerdesInit

Description
This API initializes the Serdes CMU and COMLANE registers.

Arguments base_addr, ref_clock, rate

Return Value CSL_SERDES_RESULT

Pre Condition
None

Post Condition
None

Reads
None

Usage Constraints:
None

Example

 
    csl_retval = CSL_HyperlinkSerdesInit(CSL_HYPERLINK_0_SERDES_CFG_REGS, CSL_SERDES_REF_CLOCK_156p25M, CSL_SERDES_LINK_RATE_6p25G);

    

===========================================================================

CSL_IDEF_INLINE void CSL_HyperlinkSerdesLaneConfig ( uint32_t  base_addr,
CSL_SERDES_REF_CLOCK  ref_clock,
CSL_SERDES_LINK_RATE  rate,
uint32_t  lane_num 
)

============================================================================
CSL_HyperlinkSerdesLaneConfig

Description
This API is currently deprecated and the functionality is integrated into CSL_HyperlinkSerdesInit API. It is currently used for backwards compatibility.

Arguments base_addr, ref_clock, rate, lane_num

Return Value None

Pre Condition
None

Post Condition
None

Reads
None

Usage Constraints:
None

Example

 
     CSL_HyperlinkSerdesLaneConfig(CSL_HYPERLINK_0_SERDES_CFG_REGS, CSL_SERDES_REF_CLOCK_156p25M, CSL_SERDES_LINK_RATE_6p25G, 1);

    

===========================================================================

CSL_IDEF_INLINE void CSL_HyperlinkSerdesLaneDisable ( uint32_t  base_addr,
uint32_t  lane_num 
)

============================================================================
CSL_HyperlinkSerdesLaneDisable

Description
This API disables the Serdes Lanes

Arguments base_addr, lane_num

Return Value None

Pre Condition
None

Post Condition
None

Reads
None

Usage Constraints:
None

Example

 
     CSL_HyperlinkSerdesLaneDisable(CSL_HYPERLINK_0_SERDES_CFG_REGS, 0);

    

===========================================================================

CSL_IDEF_INLINE void CSL_HyperlinkSerdesLaneEnable ( uint32_t  base_addr,
uint32_t  lane_num,
CSL_SERDES_LOOPBACK  loopback_mode,
CSL_SERDES_LANE_CTRL_RATE  lane_ctrl_rate 
)

============================================================================
CSL_HyperlinkSerdesLaneEnable

Description
This API enables the Serdes CMU and COMLANE

Arguments base_addr, lane_num, loopback_mode, lane_ctrl_rate

Return Value None

Pre Condition
None

Post Condition
None

Reads
None

Usage Constraints:
None

Example

 
     CSL_HyperlinkSerdesLaneEnable(CSL_HYPERLINK_0_SERDES_CFG_REGS, 0, CSL_SERDES_LOOPBACK_DISABLED, CSL_SERDES_LANE_FULL_RATE);

    

===========================================================================

CSL_IDEF_INLINE void CSL_HyperlinkSerdesLaneReset ( uint32_t  base_addr,
uint32_t  lane_num 
)

============================================================================
CSL_HyperlinkSerdesLaneReset

Description
This API resets the Serdes Lanes

Arguments base_addr, lane_num

Return Value None

Pre Condition
None

Post Condition
None

Reads
None

Usage Constraints:
None

Example

 
     CSL_HyperlinkSerdesLaneReset(CSL_HYPERLINK_0_SERDES_CFG_REGS, 0);

    

===========================================================================

CSL_IDEF_INLINE void CSL_HyperlinkSerdesPllEnable ( uint32_t  base_addr)

============================================================================
CSL_HyperlinkSerdesPllEnable

Description
This API enables the PLL

Arguments base_addr

Return Value None

Pre Condition
None

Post Condition
None

Reads
None

Usage Constraints:
None

Example

 
     CSL_HyperlinkSerdesPllEnable(CSL_HYPERLINK_0_SERDES_CFG_REGS);

    

===========================================================================

CSL_IDEF_INLINE void CSL_HyperlinkSerdesShutdown ( uint32_t  base_addr)

============================================================================
CSL_HyperlinkSerdesShutdown

Description
This API shuts down the Serdes by Disabling and Resetting the Serdes

Arguments base_addr

Return Value None

Pre Condition
None

Post Condition
None

Reads
None

Usage Constraints:
None

Example

 
     CSL_HyperlinkSerdesShutdown(CSL_HYPERLINK_0_SERDES_CFG_REGS);

    

===========================================================================


Copyright 2014, Texas Instruments Incorporated