Component - MDIO Interface V1.20

®
PSoC Creator™ Component Datasheet
MDIO Interface
1.20
Features
 Used in conjunction with Ethernet products
 Configurable physical address
 Supports up to 4.4 MHz in the clock bus (mdc)
 Compliant with IEEE 802.3 Clause 45
 Automatically allocates memory for the register spaces that can be
configured through an intuitive, easy-to-use graphical configuration GUI
General Description
The MDIO Interface component supports the Management Data Input/Output, which is a serial
bus defined for the Ethernet family of IEEE 802.3 standards for the Media Independent Interface
(MII). The MII connects Media Access Control (MAC) devices with Ethernet physical layer (PHY)
circuits. The component is compliant with IEEE 802.3 Clause 45.
When to Use an MDIO Interface
Use the MDIO Interface component in a PHY management interface to read and write the PHY
control and status registers. They configure each PHY before operation and monitor link status
during operation.
The component can be configured to generate an interrupt for any frame received from the
MDIO bus. In Basic mode, it lets users implement their own data handling algorithms in firmware.
In Advanced mode, it can be configured to automatically handle all the registers in hardware
without CPU intervention.
Cypress Semiconductor Corporation • 198 Champion Court • San Jose, CA 95134-1709 • 408-943-2600
Document Number: 001-93588 Rev. **
Revised August 14, 2014
MDIO Interface
®
PSoC Creator™ Component Datasheet
Input/Output Connections
This section describes the various input and output connections for the MDIO Interface
component. An asterisk (*) in the list of I/Os indicates that the I/O may be hidden on the symbol
under the conditions listed in the description of that I/O.
mdc – Input
MDC is the bus clock provided by the MDIO Host. It is directly connected to the physical MDC
input pin. Set the Sync mode parameter (on the pins component Configure dialog) to
Transparent for a pin connected to mdc input.
clock – Input
This clock is used for internal logic timing. Refer to the Clock Selection section for a detailed
description on component clock requirements.
phy_addr – Input *
Physical port address. Displays if a Hardware option is set for the Physical parameter. The
address width can be three or five bits depending on Address width parameter settings. Setting
the address width to three bits allows component to respond to four different physical addresses
from an MDIO frame. That is, the two most significant address bits from an MDIO frame will be
ignored by the component. For example, if a 3-bit physical address is set to 0x4, the component
will respond to the following address values: 0x04, 0x0C, 0x14, and 0x1C.
mdio – Inout *
A bidirectional pin that transmits or receives data. The pin connected to mdio should be
configured to have Drive mode as “Open drain, drains low” and Sync mode as “Transparent.”
The mdio terminal displays if the Enable external OE parameter is unchecked.
mdio_in – Input *
MDIO signal driven by the Host. Displays when the Enable external OE option is checked.
mdio_out – Output *
MDIO signal driven by the MDIO Interface. Displays when the Enable external OE option is
checked.
enable – Input
Synchronous active high enable signal.
Page 2 of 25
Document Number: 001-93588 Rev. **
®
PSoC Creator™ Component Datasheet
MDIO Interface
interrupt – Output
When configured in Basic mode, this output generates a pulse in the end of the frame only if
the physical address and device address match the pre-configured values.
In Advanced mode, a pulse is generated when the MDIO Host finishes a writing operation and
the associated register is configured to trigger interrupt on write.
force_cor – Input *
Forces a clear on read for the current MDIO address. Displays if an Advanced option is set for
the Configuration parameter.
en_page[x] – Input *
Enable/disable the corresponding register space. When the page is disabled, the component
drives high during the data portion of a read frame and ignores the data of a write frame. The
width of this signal depends on the number of register spaces managed by the component.
Displays if an Advanced option is set for the Configuration parameter.
read – Output *
This output generates a pulse when the MDIO Host finishes a reading operation and the
associated register is configured to trigger interrupt on read. Displays if an Advanced option is
set for the Configuration parameter.
address – Output *
This output generates a pulse in the end of every address frame sent by the MDIO Host.
Displays if an Advanced option is set for the Configuration parameter.
cor – Output *
This output generates a pulse when a read frame is received and the register is configured to be
cleared on read. Displays if an Advanced option is set for the Configuration parameter.
aux[4:1] – Output *
Outputs auxiliary bits associated with a register that is being accessed. Displays if an Advanced
option is set for the Configuration parameter and the Enable auxiliary bits option is checked.
Document Number: 001-93588 Rev. **
Page 3 of 25
®
MDIO Interface
PSoC Creator™ Component Datasheet
Schematic Macro Information
The PSoC Creator Component Catalog provides two macros for Basic and Advanced mode
operation as shown in the following diagrams. These macros contain the MDIO Interface
component already connected to a digital pin, clock, and an interrupt. The Sync mode
parameter (on the pins component Configure dialog) is set to Transparent on the mdc and mdio
pins.
Basic Mode
Page 4 of 25
Advanced Mode
Document Number: 001-93588 Rev. **
®
PSoC Creator™ Component Datasheet
MDIO Interface
Component Parameters
Drag an MDIO Interface component onto your design and double-click it to open the Configure
dialog. This dialog has the following tabs with different parameters.
Basic Tab
Configuration
Determines which mode the component operates – Basic (default) or Advanced.
Physical address
Specifies whether the physical address is updated using phy_addr port address bus or firmware
API, and the default physical address if a Firmware option is set. Options for the address mode
are Firmware (default) or Hardware.
The address width can be set to 3 or 5 bits (default). The address value can be set between 0
and 0x1F for 5-bit address physical address or between 0 and 7 when 3-bit address is selected.
The default setting is 0x04.
Device address
Specifies the device type of the MDIO Interface. The value can be set to PMA/PMD, WIS, PCS,
PHY XS or DTE XS. The default setting is PMA/PMD.
Document Number: 001-93588 Rev. **
Page 5 of 25
MDIO Interface
®
PSoC Creator™ Component Datasheet
Enable external OE
Allows you to split the mdio bidirectional in the mdio_in input and mdio_out output signals.
Options = Checked or unchecked. Enabling this option exposes the mdio inout to mdio_in
input and mdio_out output on the symbol. (Default = unchecked).
Register Spaces Tab
This tab is available only in Advanced mode and follows the CFP Register Set specified in the
CFP MSA specification. The tab allows you to allocate CFP register spaces and configuring
parameters for each single register that belongs to the allocated register spaces.
Enable auxiliary bits
Globally enables auxiliary bits field for all register spaces. Options = Checked or unchecked.
(Default = Unchecked).
Name
Text field, 24 characters, used to create C MACROs for the quick access register space start
address and end address. By default this field is labeled REGISTER_SPACE_N (where
N=1..Number of register spaces).
Page 6 of 25
Document Number: 001-93588 Rev. **
®
PSoC Creator™ Component Datasheet
MDIO Interface
Start address
Defines the start address in hex for each of the allocated register spaces. The value can be set
from 0x8000 to 0xFFFF.
End address
Defines the end address in hex for each of the allocated register spaces. The value can be set
from 0x8000 to 0xFFFF and must be larger than the start address of the associated register
space.
Register stored in
Determines the memory location of the register space. The register space data can be stored in
either Flash or SRAM (default).
Data width
Specifies if the data is 8-bit or 16-bit width.
Config stored in
Determines the memory location of the configuration data associated with the register space.
The register space configuration can be stored in either Flash (default) or SRAM.
Note The configuration of each register space contains four bytes of parameters for each
register in this register space.
Initial value
Defines the register initial value in hex. Can be 8-bit or 16-bit value depending on the Data width
parameter for the associated register space. (Default = 0).
Mask value
Defines the register writable bit mask in hex. Can be 8-bit or 16-bit value depending on the Data
width parameter for the associated register space. Ignored if the associated register space is
located in Flash. (Default = 0).
Clear on read
Defines the register to be clear on read. Options = Checked or unchecked. If checked, the
register is cleared to 0 upon MDIO Host read. Ignored if the associated register space is located
in Flash. (Default = Unchecked).
Note that clear on read is 16-bit wide operation. If an 8-bit register is configured to be clear on
read, reading of this register will clear its value and the value stored in subsequent memory
address.
Document Number: 001-93588 Rev. **
Page 7 of 25
®
MDIO Interface
PSoC Creator™ Component Datasheet
Write only
Defines the register to be write only. Options = Checked or unchecked. If the MDIO Host reads a
write only register, 0xFFFF is returned for the data portion of an MDIO frame. Ignored if the
associated register space is located in Flash. (Default = Unchecked).
Trigger on write
Defines whether the interrupt output generates a pulse at the end of a write operation by the
MDIO Host to the corresponding register. Options = Checked or unchecked. Ignored if the
associated register space is located in Flash. (Default = Unchecked).
Trigger on read
Defines whether the read output generates a pulse at the end of a read operation by the MDIO
Host to the corresponding register. Options = Checked or unchecked. Ignored if the associated
register space is located in Flash. (Default = Unchecked).
Aux bits
Defines the 4-bit binary value exposing to the aux[4:1] output when the corresponding register is
accessed by the MDIO Host. These bits are required when a specific register access needs to
be indicated directly to other hardware. Displays when the Enable auxiliary bits option is
checked. Ignored if the associated register space is located in Flash (Default = 0).
Application Programming Interface
Application Programming Interface (API) routines allow you to configure the component using
software. The following table lists and describes the interface to each function. The subsequent
sections discuss each function in more detail.
By default, PSoC Creator assigns the instance name “MDIO_Interface_1” to the first instance of
a component in a given design. You can rename the instance to any unique value that follows
the syntactic rules for identifiers. The instance name becomes the prefix of every global function
name, variable, and constant symbol. For readability, the instance name used in the following
table is “MDIO_Interface.”
Functions
Function
Description
MDIO_Interface_Start()
Initializes and enables the MDIO Interface.
MDIO_Interface_Stop()
Disables the MDIO Interface.
MDIO_Interface_Init()
Initializes default configuration provided with customizer.
MDIO_Interface_Enable()
Enables the MDIO Interface.
Page 8 of 25
Document Number: 001-93588 Rev. **
®
PSoC Creator™ Component Datasheet
Function
MDIO Interface
Description
MDIO_Interface_EnableInt()
Enables the interrupt output terminal.
MDIO_Interface_DisableInt()
Disables the interrupt output terminal.
MDIO_Interface_SetPhyAddress()
Sets the physical address for the MDIO Interface.
MDIO_Interface_UpdatePhyAddress()
Updates the physical address of the MDIO Interface.
MDIO_Interface_SetDevAddress()
Sets the device address for the MDIO Interface.
MDIO_Interface_GetData()
Returns the value stored in the given address.
MDIO_Interface_SetData()
Sets the argument value in the given address.
MDIO_Interface_SetBits()
Sets the specified bits at the specified address.
MDIO_Interface_GetAddress()
Returns the last address written by the MDIO Host.
MDIO_Interface_GetConfiguration()
Returns a pointer to the configuration array of the given register space.
MDIO_Interface_PutData()
Sets the data to be transmitted to the MDIO Host.
MDIO_Interface_ProcessFrame()
Processes the last frame received from the MDIO Host.
MDIO_Interface_Sleep()
Stops the MDIO Interface and saves the user configuration.
MDIO_Interface_Wakeup()
Restores the user configuration and enables the MDIO Interface.
MDIO_Interface_SaveConfig()
Saves the current user configuration.
MDIO_Interface_RestoreConfig()
Restores the user configuration.
void MDIO_Interface_Start(void)
Description:
This is the preferred method to begin component operation. This function sets the initVar
variable, calls the MDIO_Interface_Init() function, and then calls the
MDIO_Interface_Enable() function.
Parameters:
None
Return Value:
None
Side Effects:
If the initVar variable is already set, this function only calls the MDIO_Interface_Enable()
function.
void MDIO_Interface_Stop(void)
Description:
Disables the MDIO Interface. If the component is configured to operate in Advanced mode,
this function disables all internal DMA channels.
Parameters:
None
Return Value:
None
Side Effects:
None
Document Number: 001-93588 Rev. **
Page 9 of 25
®
MDIO Interface
PSoC Creator™ Component Datasheet
void MDIO_Interface_Init(void)
Description:
Initializes or restores default MDIO Interface configuration provided with customizer.
Initializes internal DMA channels if the component is configured to operate in Advanced
mode. It is not necessary to call MDIO_Interface_Init() because the MDIO_Interface_Start()
routine calls this function, which is the preferred method to begin component operation.
Parameters:
None
Return Value:
None
Side Effects:
None
void MDIO_Interface_Enable(void)
Description:
Activates the hardware and begins component operation. It is not necessary to call
MDIO_Interface_Enable() because the MDIO_Interface_Start() routine calls this function,
which is the preferred method to begin component operation.
Parameters:
None
Return Value:
None
Side Effects:
Enables the terminal output interrupt if it was disabled by MDIO_Interface_DisableInt() API.
void MDIO_Interface_EnableInt(void)
Description:
Enables the terminal output interrupt.
Parameters:
None
Return Value:
None
Side Effects:
None
void MDIO_Interface_DisableInt(void)
Description:
Disables the terminal output interrupt.
Parameters:
None
Return Value:
None
Side Effects:
None
Page 10 of 25
Document Number: 001-93588 Rev. **
®
PSoC Creator™ Component Datasheet
MDIO Interface
void MDIO_Interface_SetPhyAddress(uint8 phyAddr)
Description:
Sets the 5-bit or 3-bit physical address for the MDIO slave device. For 3-bit address, the
two most significant address bits from an MDIO frame will be ignored. For example, if 3-bit
physical address is set to 0x4, the component will respond to the following physical
addresses from an MDIO frame: 0x04, 0x0C, 0x14, and 0x1C.
Parameters:
phyAddr: The physical address value.
Return Value:
None
Side Effects:
Overwrites the default physical address defined in the customizer.
void MDIO_Interface_UpdatePhyAddress(void)
Description:
Updates the physical address based on the current value of phy_addr input signal. If a
Firmware option is set for the Physical address parameter, the address is set equal to the
default value from the customizer.
Parameters:
None
Return Value:
None
Side Effects:
None
void MDIO_Interface_SetDevAddress(uint8 devAddr)
Description:
Sets the 5-bit device address for the MDIO Interface.
Parameters:
devAddr: The device address value.
Return Value:
None
Side Effects:
Overwrites the default device address defined in the customizer.
Document Number: 001-93588 Rev. **
Page 11 of 25
®
MDIO Interface
PSoC Creator™ Component Datasheet
cystatus MDIO_Interface_GetData(uint16 address, const uint16 *regData,
uint16 numWords)
Description:
Returns N values starting from the given address. If any address does not belong to the
allocated register space, it returns an error. This API is only available in Advanced mode.
Parameters:
address: address to be accessed.
regData: array with the read data.
numWords: number of words to be read.
Return Value:
Side Effects:
Value
Description
CYRET_SUCCESS
Successful
CYRET_BAD_PARAM
One or more invalid parameters
CYRET_TIMEOUT
Operation timed out
None
cystatus MDIO_Interface_SetData(uint16 address, const uint16 *regData,
uint16 numWords)
Description:
Writes N values starting from the given address. If any address does not belong to the
allocated register space or the register space is located in Flash, it returns an error. This
API is only available in Advanced mode and if at least one register space is located in
SRAM.
Parameters:
address: address to be accessed.
regData: array with the data to be written.
numWords: number of words to be written.
Return Value:
Side Effects:
Page 12 of 25
Value
Description
CYRET_SUCCESS
Successful
CYRET_BAD_PARAM
One or more invalid parameters
CYRET_TIMEOUT
Operation timed out
None
Document Number: 001-93588 Rev. **
®
PSoC Creator™ Component Datasheet
MDIO Interface
cystatus MDIO_Interface_SetBits(uint16 address, uint16 regBits)
Description:
Sets the bits at the given address. If the address does not belong to the allocated register
space or the register space is located in Flash, it returns an error. This API is only available
in Advanced mode and if at least one register space is located in SRAM.
Parameters:
address: address to be accessed.
regBits: bits to be set.
Return Value:
Side Effects:
Value
Description
CYRET_SUCCESS
Successful
CYRET_BAD_PARAM
One or more invalid parameters
CYRET_TIMEOUT
Operation timed out
None
uint16 MDIO_Interface_GetAddress(void)
Description:
Returns the last address written by the MDIO Host.
Parameters:
None
Return Value:
The last written address.
Side Effects:
None
uint8 MDIO_Interface_GetConfiguration(uint8 regSpace)
Description:
Returns a pointer to the configuration array of the given register space.
Parameters:
regSpace: the register space index.
Return Value:
Pointer to the configuration array.
Side Effects:
None
uint8 MDIO_Interface_PutData(uint16 regData)
Description:
Writes the given data in the internal FIFO, which will be transmitted to the host in the next
frame. Only available in Basic mode.
Parameters:
regData: data to be transmitted.
Return Value:
None
Side Effects:
None
Document Number: 001-93588 Rev. **
Page 13 of 25
®
MDIO Interface
PSoC Creator™ Component Datasheet
void MDIO_Interface_ProcessFrame(uint8* opCode, uint16* regData)
Description:
Processes and parses the last frame received from the host. Only available in Basic mode.
Parameters:
opCode: operational code.
regData: register data received.
Return Value:
None
Side Effects:
None
void MDIO_Interface_Sleep(void)
Description:
This is the preferred routine to prepare the component for sleep. The
MDIO_Interface_Sleep() routine saves the current component state. Then it calls the
MDIO_Interface_Stop() function and calls MDIO_Interface_SaveConfig() to save the
hardware configuration.
Call the MDIO_Interface_Sleep() function before calling the CyPmSleep() or the
CyPmHibernate() function. See the PSoC Creator System Reference Guide for more
information about power-management functions.
Parameters:
None
Return Value:
None
Side Effects:
None
void MDIO_Interface_Wakeup(void)
Description:
This is the preferred routine to restore the component to the state when
MDIO_Interface_Sleep() was called. The MDIO_Interface_Wakeup() function calls the
MDIO_Interface_RestoreConfig() function to restore the configuration. If the component was
enabled before the MDIO_Interface_Sleep() function was called, the
MDIO_Interface_Wakeup() function also re-enables the component.
Parameters:
None
Return Value:
None
Side Effects:
Calling the MDIO_Interface_Wakeup() function without first calling the
MDIO_Interface_Sleep() or MDIO_Interface_SaveConfig() function can produce
unexpected behavior.
Page 14 of 25
Document Number: 001-93588 Rev. **
®
PSoC Creator™ Component Datasheet
MDIO Interface
void MDIO_Interface_SaveConfig(void)
Description:
This function saves the component configuration and non-retention registers. It also saves
the current component parameter values, as defined in the Configure dialog or as modified
by appropriate APIs. This function is called by the MDIO_Interface_Sleep() function.
Parameters:
None
Return Value:
None
Side Effects:
None
void MDIO_Interface_RestoreConfig(void)
Description:
This function restores the component configuration and nonretention registers. It also
restores the component parameter values to what they were before calling the
MDIO_Interface_Sleep() function.
Parameters:
None
Return Value:
None
Side Effects:
If this API is called before MDIO_Interface_SaveConfig(), the component configurations will
be restored to their default settings.
Global Variables
Variable
MDIO_Interface_initVar
Description
MDIO_Interface_initVar indicates whether the MDIO Interface has been
initialized. The variable is initialized to 0 and set to 1 the first time
MDIO_Interface_Start() is called. This allows the component to restart
without reinitialization after the first call to the MDIO_Interface_Start()
routine.
If reinitialization of the component is required, then the MDIO_Interface_Init()
function can be called before the MDIO_Interface_Start() or
MDIO_Interface_Enable() function.
Document Number: 001-93588 Rev. **
Page 15 of 25
®
MDIO Interface
PSoC Creator™ Component Datasheet
Variable
Description
MDIO_Interface_registerConfig_N[] Stores register configuration associated with the register space N. N=1..8 –
the number of register spaces allocated by the component. Any of these
(Advanced mode only)
arrays can be accessed directly using associated API constant described in
API Constants section later in this document.
Note that the configuration of each register space contains four bytes of
parameters for each register in this register space. These parameters are
stored in the C structure declared as follows:
typedef struct
{
uint16 mask;
/* 16 bit writable mask */
uint8 ctrlReg;
/* Register configuration */
uint8 reserved; /* Reserved */
}
mask: defines register bit access type from Host. 0 – R. 1 – R/W. All bits are
R/W from component APIs.
ctrlReg: register configuration bits
bit 0: generate pulse on read
bit 1: generate pulse on write
bit 2: write only
bit 3: clear on read
bit 7-4: auxiliary bits (aux[4:1])
For each allocated register space, the MDIO_Interface_registerConfig_N[] is
initialized based on the register settings in customizer. Usually there is no
need to access or modify these arrays.
MDIO_Interface_registerSpace_N[] Stores register values for the register space N. N=1..8 – the number of
register spaces allocated by the component. Any of these arrays can be
(Advanced mode only)
accessed directly using associated API constant described in API Constants
section later in this document. The preferred method to access these arrays
is to use the MDIO_GetData() function to obtain the register values, and
MDIO_SetData() function to modify the register values within the
MDIO_Interface_registerSpace_N[] array.
API Constants
Variable
[1]
Description
MDIO_Interface_ADDRESS
Operation code for an address frame
MDIO_Interface_WRITE
Operation code for a write frame
MDIO_Interface_READ
Operation code for a read frame
MDIO_Interface_POS_READ
Operation code for a post read frame
1.
RegSpaceName – the name entered in customizer for a given register space.
Page 16 of 25
Document Number: 001-93588 Rev. **
®
PSoC Creator™ Component Datasheet
Variable
MDIO Interface
[1]
Description
MDIO_Interface_NUMBER_OF_PAGES
Number of allocated register spaces
MDIO_Interface_RegSpaceName_IDX
Index of the register space
MDIO_Interface_RegSpaceName_START
Starting address of the register space
MDIO_Interface_RegSpaceName_END
Ending address of the register space
MDIO_Interface_RegSpaceName_PTR
Extern reference to the array that stores register data for the
associated register space
MDIO_Interface_RegSpaceName_CONFIG_PTR
Extern reference to the array that stores configuration data
for the associated register space
Sample Firmware Source Code
PSoC Creator provides many example projects that include schematics and example code in the
Find Example Project dialog. For component-specific examples, open the dialog from the
Component Catalog or an instance of the component in a schematic. For general examples,
open the dialog from the Start Page or File menu. As needed, use the Filter Options in the
dialog to narrow the list of projects available to select.
Refer to the “Find Example Project” topic in the PSoC Creator Help for more information.
MISRA Compliance
This section describes the MISRA-C:2004 compliance and deviations for the component. There
are two types of deviations defined:


project deviations – deviations that are applicable for all PSoC Creator components
specific deviations – deviations that are applicable only for this component
This section provides information on component-specific deviations. Project deviations are
described in the MISRA Compliance section of the System Reference Guide along with
information on the MISRA compliance verification environment.
The MDIO Interface component has the following specific deviations:
MISRAC:2004
Rule
11.4
Rule Class
(Required/
Advisory)
A
Rule Description
Description of Deviation(s)
A cast should not be
performed between a pointer
to object type and a different
pointer to object type.
The casts between a pointer to object type and a
different pointer to object type is used to map a CFP
register space to the component internal memory when
configuring DMA data movement.
Document Number: 001-93588 Rev. **
Page 17 of 25
®
MDIO Interface
MISRAC:2004
Rule
19.7
PSoC Creator™ Component Datasheet
Rule Class
(Required/
Advisory)
A
Rule Description
A function should be used in
preference to a function-like
macro.
Description of Deviation(s)
Deviations with function-like macros to allow for more
efficient code.
The component allocates 8 or 16-bit registers in Flash
or SRAM. Macros with arguments are used to quickly
determine register width and memory location.
This component has the following embedded components: DMA. Refer to the corresponding
component datasheet for information on their MISRA compliance and specific deviations.
API Memory Usage
The component memory usage varies significantly, depending on the compiler, device, number
of APIs used and component configuration. The following table provides the memory usage for
all APIs available in the given component configuration.
The measurements have been done with associated compiler configured in Release mode with
optimization set for Size. For a specific design, the map file generated by the compiler can be
analyzed to determine the memory usage.
PSoC 3 (Keil_PK51)
Configuration
Basic
Advanced
2.
[2]
PSoC 4 (GCC)
PSoC 5LP (GCC)
Flash
SRAM
Flash
SRAM
Flash
SRAM
Bytes
Bytes
Bytes
Bytes
Bytes
Bytes
365
5
N/A
N/A
460
7
4.3K + RFLS
53 + RSRAM
N/A
N/A
2.8K + RFLS
86 + RSRAM
In Advanced mode, the component automatically allocates and manages CFP register table. RFLS and RSRAM are the Flash and
SRAM memory usage to store the register data and configuration. They can be calculated using the following equations:
RSRAM = 16*PAGE_NUM + REG_NUM_SRAM8-BIT + 2*REG_NUM_SRAM16-BIT + 4*REG_NUM_CFG_SRAM
RFLS = 8*PAGE_NUM + REG_NUM_FLS8-BIT + 2*REG_NUM_FLS16-BIT + 4*REG_NUM_CFG_FLS, where:
• PAGE_NUM – Number of allocated register pages
• REG_NUM_SRAM8-BIT and REG_NUM_SRAM16-BIT – Number of 8 and 16-bit registers stored in SRAM
• REG_NUM_FLS8-BIT and REG_NUM_FLS16-BIT – Number of 8 and 16-bit registers stored in Flash
• REG_NUM_CFG_SRAM – Number of registers with configuration stored in SRAM
• REG_NUM_CFG_FLS – Number of registers with the configuration stored in Flash
Page 18 of 25
Document Number: 001-93588 Rev. **
®
PSoC Creator™ Component Datasheet
MDIO Interface
Functional Description
Definitions

CFP Module – C Form-factor Pluggable (CFP) Optical Module for 40-Gbps and 100-Gbps
Ethernet.

MDIO Host – Main system processor that controls and monitors the startup, shutdown
and operation of the CFP Optical Module(s).

CFP Management Interface – A management interface between the Host and the CFP
Module for control and diagnostics.

Management Data Input/Output (MDIO) Bus – An industry-standard (IEEE 802.3) serial
bus that consists of MDC and MDIO hardware signals. MDC is the MDIO Clock line driven
by the Host and MDIO is the bi-directional data line driven by both the Host and module
depending upon the data directions.

CFP Register Set – Stores CFP Optical Module ID information, configuration, diagnostic
data and vendor-specific data configured as 16-bit words, each occupying one MDIO
address.
CFP Module overview
The MDIO_Slave component supports the IEEE 802.3 standards for the Media Independent
(MII) clause 45 specification. It is used in agreement with the CFP Management Interface, which
specifies the use of MDIO bus as the management interface between a host and a CFP module.
The block diagram of the CFP module is shown in the following figure.
The MDIO Host uses this interface to control and monitor the startup, shutdown and normal
operation of the CFP modules it manages. At the same bus, multiple slaves can be connected to
Document Number: 001-93588 Rev. **
Page 19 of 25
MDIO Interface
®
PSoC Creator™ Component Datasheet
the same host with different bus addresses. The address of the module can be configured
through the Port Address bus.
The component interfaces with the host through two lines: a data line designated as MDIO bus,
and a clock line designated as MDC. The MDIO bus is bidirectional and is transmitted at the rate
specified in MDC. The MDC clock then is driven by the host to control the communication rate.
Once enabled, the MDIO Interface component continuously monitors and communicates with the
MDIO Host device. In basic mode, the end of each MDIO frame triggers an interrupt that allows
the user to transfer this captured data in the FIFO to the system memory by using the necessary
API. The advanced mode examines the packet information and allows the packet transfers to
take place to and from the system memory.
When running in advance mode, the MDIO component allocates CFP register table automatically
based on the customizer settings. The component supports the following register access types:





Read only registers
Read/write registers
Read only and read/write mixed within a 16-bit word environment
Clear on read registers
Write only registers
All these features are handled in hardware when the MDIO Host sends a read/write frame.
If the MDIO Host reads a Write only register, 0xFFFF is returned to the Host. If the MDIO Host
writes in a read only register or in a read only bits, the whole frame or the read only bits are
ignored be the MDIO Interface component.
Any access to addresses between 0x0000 and 0x7FFF is ignored (no activity in the MDIO bus).
Page 20 of 25
Document Number: 001-93588 Rev. **
®
PSoC Creator™ Component Datasheet
MDIO Interface
Block Diagram and Configuration
The MDIO Interface component is implemented as a set of configured UDBs. In Basic mode, it
triggers an interrupt for any frame received from the MDIO bus that allows the user to implement
their own CFP Register Set along with data handling algorithms firmware.
In Advanced mode, it can be configured to automatically allocate and handle CFP Register Set
in hardware without CPU intervention. The component uses DMAs to make the transfers to and
from the system SRAM/Flash. The implementation is shown in the following block diagrams.
MDIO Interface (Basic mode)
MDIO Bus
Port Address
Bus
2
APIs
MDIO
Interface
5
CPU
(8051/
Cortex M3)
CFP
Register Set
(Flash/SRAM)
interrupt
MDIO Interface (Advanced mode)
MDIO Bus
Port Address
Bus
DMA
Channels
2
5
MDIO
Interface
Address
Analyzer
CFP
Register Set
(Flash/SRAM)
APIs
CPU
(8051/
Cortex M3)
interrupt
Clock Selection
When the component operates in Basic mode, the clock rate must be set at least 8x the MDC
bus clock. In Advanced mode, it is recommended to clock the component from the BUS_CLK
configured to at least 40 MHz. To guarantee the timing requirements specified in the CFP MSA
specification the component must operate at 40 MHz clock rate.
Registers
The MDIO Interface component has several control and status registers that are used by the
firmware APIs to control operation and monitor status. None of these registers are accessible
directly by user firmware.
Document Number: 001-93588 Rev. **
Page 21 of 25
®
MDIO Interface
PSoC Creator™ Component Datasheet
Resources
The MDIO Interface component is placed throughout the UDB array. When configured in
Advanced mode, the component uses DMAs to make the transfers to and from the system
SRAM/Flash. The component utilizes the following resources.
Configuration
Resource Type
Datapath Cells
Macrocells
Status Cells
Control Cells
DMA Channels
Interrupts
Basic mode
2
16
2
2
–
–
Advanced mode
8
59
3
5
10
–
DC and AC Electrical Characteristics
Specifications are valid for –40 °C ≤ TA ≤ 85 °C and TJ ≤ 100 °C, except where noted.
Specifications are valid for 1.71 V to 5.5 V, except where noted.
DC Characteristics
Parameter
Min
Typ
Max
Unit
Input high voltage
0.8
–
5.5
V
Input low voltage
-0.5
–
0.42
V
–
–
–
V
Output low voltage (IOL = 100 µA)
0.001
–
0.002
V
Output high current (VOH = 1.0 V)
–
–
–
mA
IOL
Output low current (VOL = 0.2 V)
10
–
–
mA
Ci
Input Capacitance
–
–
7
pF
VIH
VIL
VOH
[3]
VOL
IOH
[4]
Description
Output high voltage (IOH = -100 µA)
AC Characteristics
Parameter
Description
Min
Typ
Max
Units
–
–
4.4
MHz
8 * fMDC
40
–
MHz
fMDC
MDC clock frequency
fCLOCK
Component clock frequency
tSETUP
Host MDIO setup time
10
–
–
ns
tHOLD
Host MDIO hold time
10
–
–
ns
tDELAY
CFP MDIO delay time
–
–
150
ns
3.
4.
PSoC output driver is open drain, so VOH is determined by pullup resistor on the MDIO bus.
IOH is not applicable to open drain drivers.
Page 22 of 25
Document Number: 001-93588 Rev. **
®
PSoC Creator™ Component Datasheet
MDIO Interface
MDC/MDIO Timing Diagram
tSETUP
VIH
VIL
MDC CFP Input
tHOLD
MDIO CFP Input
tDELAY
MDIO CFP Output
VIH
VIL
VOH
VOL
How to Use STA results for Characteristics Data
MDIO setup and hold time
The setup and hold time are not provided directly by the STA. However, the data provided in the
STA results indicates some of the internal logic timing constraints that can be used for timing
calculation. To guarantee the timing requirements for your system, the relationship between
MDC and MDIO must meet the following equation:
-tH_CFP + tS_MC ≤ tDELAY ≤ tS_CFP
where:
tDELAY = difference between MDIO and MDC path delays at component inputs
tS_CFP = setup time requirement provided by the MDIO host device
tH_CFP = hold time requirement provided by the MDIO host device
tS_MC = setup time requirement of PSoC macrocell (3.51 ns)
The difference between MDIO and MDC path delays can be found in the Input to Clock Section
of the STA report as shown below. (The pins connected to mdc and mdio component inputs are
named MDC and MDIO correspondingly):
Slack for the setup time is (tS_CFP - tDELAY), and slack for the hold time is (tH_CFP + tDELAY - tS_MC).
For example, tDELAY = 1.377 ns, tS_CFP = 10 ns and tH_CFP = 10 ns result in about 8.6 ns slack for
the setup time and about 7.9 ns for the hold time.
Document Number: 001-93588 Rev. **
Page 23 of 25
®
MDIO Interface
PSoC Creator™ Component Datasheet
MDIO delay time
The MDIO delay time is determined as a sum of the delay through the component which is five
component clocks and the clock to output time of the device that is about 25 ns. To meet the
delay time specified in the CFP MSA spec, clock everything from the BUS_CLK running at least
at 40 MHz. This results in about 150 ns delay.
References
 CFP MSA Management Interface Specification v2.0
 CFP MSA Hardware Specification v1.4
Component Changes
This section lists the major changes in the component from the previous version.
Version
1.20
Description of Changes
Corrected a problem that caused component
failures in Basic mode of operation when the
data portion of received MDIO frame matched
one of the specified data patterns and device
address was set to PMA/PD (0x01), PCS
(0x03) or DTE XS (0x05).
Advanced mode of operation and device
addresses WIS (0x02) and PHY XS (0x04)
were not affected.
Reason for Changes/Impact
The component failed to operate in Basic mode when
the data bits of the MDIO frame matched specific data
patterns for the following Device addresses:
PMA/PD
X
1
1
0
0
X
X
PHYADDR
0
0
0
0
PHYADDR
0
0
0
1
0
0
0
0
1
0
PCS
X
1
1
0
0
X
X
X
X
1
1
0
0
X
0
0
X
X
X
PHYADDR
DTE XS
X
1
1
PHYADDR
0
For example, if device address = PMA/PD and physical
address (PHYADDR) = 0x04, the failures occurred for
the following data: 0x6040, 0x6240, 0x6440, 0x6640,
0xE040, 0xE240, 0xE440, 0xE640.
Added the option to set 5-bit or 3-bit physical
address. When 3-bit address is set, the
component will respond to four different
physical addresses from an MDIO frame.
Improvements based on usability feedbacks. No impact
on existing designs.
A read attempt to a write only register returns
logic low for turnaround (TA) bits. Previously
logic high was returned.
Compliance with the requirements of the CFP MSA
specification. MDIO Hosts that check TA bits expect
them to be logic low for a read frame.
Corrected a problem with detection a DMA
completion status in SetBits() API function.
Function may return before operation completeness.
Page 24 of 25
Document Number: 001-93588 Rev. **
®
PSoC Creator™ Component Datasheet
Version
1.10
Description of Changes
MDIO Interface
Reason for Changes/Impact
Datasheet update and corrections.
To reflect all changes in version 1.20.
Added aux[4:1] output and auxiliary bits
support in customizer.
Allows indication of specific register access directly to
other hardware.
Improved logic timing model to meet the
setup and hold requirements specified in the
CFP MSA Hardware specification.
Compliance the timing requirements specified in the
CFP MSA Hardware specification. Note The pins
connected to mdc/mdio terminals must be configured to
have Sync mode parameter set to Transparent.
Implemented 255 us timeouts and improved
status reporting for the SetData(), GetData()
and SetBits() APIs.
Improves reliability for the SetData(), GetData() and
SetBits() APIs.
A read attempt to the disabled register page
returns 0xFFFF for the data portion of a read
frame. Previously 0x0000 was returned.
Compliance with the requirements of the CFP MSA
specification.
Removed PSoC 5 support
PSoC 5 is no longer supported starting from PSoC
Creator 3.0 release.
1.0.a
Datasheet update and corrections
1.0
Version 1.0 is the first release of the MDIO
Interface component
© Cypress Semiconductor Corporation, 2014. The information contained herein is subject to change without notice. Cypress Semiconductor Corporation assumes no responsibility for the use of
any circuitry other than circuitry embodied in a Cypress product. Nor does it convey or imply any license under patent or other rights. Cypress products are not warranted nor intended to be used
for medical, life support, life saving, critical control or safety applications, unless pursuant to an express written agreement with Cypress. Furthermore, Cypress does not authorize its products for
use as critical components in life-support systems where a malfunction or failure may reasonably be expected to result in significant injury to the user. The inclusion of Cypress products in lifesupport systems application implies that the manufacturer assumes all risk of such use and in doing so indemnifies Cypress against all charges.
PSoC® is a registered trademark, and PSoC Creator™ and Programmable System-on-Chip™ are trademarks of Cypress Semiconductor Corp. All other trademarks or registered trademarks
referenced herein are property of the respective corporations.
Any Source Code (software and/or firmware) is owned by Cypress Semiconductor Corporation (Cypress) and is protected by and subject to worldwide patent protection (United States and
foreign), United States copyright laws and international treaty provisions. Cypress hereby grants to licensee a personal, non-exclusive, non-transferable license to copy, use, modify, create
derivative works of, and compile the Cypress Source Code and derivative works for the sole purpose of creating custom software and or firmware in support of licensee product to be used only in
conjunction with a Cypress integrated circuit as specified in the applicable agreement. Any reproduction, modification, translation, compilation, or representation of this Source Code except as
specified above is prohibited without the express written permission of Cypress.
Disclaimer: CYPRESS MAKES NO WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, WITH REGARD TO THIS MATERIAL, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. Cypress reserves the right to make changes without further notice to the materials described herein.
Cypress does not assume any liability arising out of the application or use of any product or circuit described herein. Cypress does not authorize its products for use as critical components in lifesupport systems where a malfunction or failure may reasonably be expected to result in significant injury to the user. The inclusion of Cypress’ product in a life-support systems application
implies that the manufacturer assumes all risk of such use and in doing so indemnifies Cypress against all charges.
Use may be limited by and subject to the applicable Cypress software license agreement.
Document Number: 001-93588 Rev. **
Page 25 of 25
Similar pages