com.xilinx.rapidwright.design.noc

Class NOCSlave

Object

com.xilinx.rapidwright.design.noc.NOCClient

com.xilinx.rapidwright.design.noc.NOCSlave

All Implemented Interfaces:

Serializable

public class NOCSlave
extends NOCClient
implements Serializable

Represents an AXI Slave instance of the NOC

Since:

2022.1.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NOCSlave() Creates an empty NOC slave client.
NOCSlave(org.json.JSONObject json) Creates a NOC slave client from a JSON client description.
NOCSlave(NOCSlave ns) Creates a copy of an existing NOC slave client.

Method Summary

Modifier and Type	Method and Description
void	addPort(String port) Adds a logical port to this slave client.
void	addSysAddress(String base, String size) Adds a system address range to this slave client.
NOCConnection	getConnectionFrom(String masterName) Gets the corresponding connection based on master client name.
int	getInterleaveSize() Gets the interleave size in bytes.
TreeMap<String,String>	getMemParams() Gets the memory parameters for this slave client.
int	getPortDestID(String portName) Gets the destination ID for a logical port.
Map<String,Integer>	getPortDestIDMap() Gets the map of logical ports to destination IDs.
List<String>	getPorts() Gets the ports on this slave client.
List<Pair<String,String>>	getSysAddresses() Gets the system address ranges for this slave client.
void	removePort(String port) Removes a logical port from this slave client.
void	removeSysAddress(String base) Removes a system address range from this slave client by base address.
void	setInterleaveSize(int bytes) Sets the interleave size in bytes.
void	setMemParams(TreeMap<String,String> memParams) Sets the memory parameters for this slave client.
void	setPortDestID(String portName, int destID) Sets the destination ID for a logical port.
void	setPortDestIDMap(Map<String,Integer> portDestIDs) Sets the map of logical ports to destination IDs.
void	setPorts(ArrayList<String> ports) Sets the logical ports on this slave client.
org.json.JSONObject	toJSONObject() Converts this slave client to its JSON representation.

Methods inherited from class com.xilinx.rapidwright.design.noc.NOCClient

addConnection, addExternalConnection, checkUnsupportedFields, getAxiDataWidth, getComponentType, getConnections, getDestID, getExternalConnections, getLocation, getName, getProtocol, getSimMetaData, hasParityAddr, hasParityData, isDDRC, isFabricClient, isVirtual, removeConnection, setAxiDataWidth, setComponentType, setDestID, setLocation, setName, setParityAddr, setParityData, setProtocol, setVirtual, toString

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NOCSlave

public NOCSlave()

Creates an empty NOC slave client.

Since:

2026.1.0

NOCSlave

public NOCSlave(NOCSlave ns)

Creates a copy of an existing NOC slave client.

Parameters:

ns - The NOC slave client to copy.

Since:

2026.1.0

NOCSlave

public NOCSlave(org.json.JSONObject json)

Creates a NOC slave client from a JSON client description.

Parameters:

json - The JSON client description.

Since:

2026.1.0

Method Detail

getMemParams

public TreeMap<String,String> getMemParams()

Gets the memory parameters for this slave client.

Returns:

The memory parameters for this slave client.

Since:

2026.1.0

setMemParams

public void setMemParams(TreeMap<String,String> memParams)

Sets the memory parameters for this slave client.

Parameters:

memParams - The memory parameters to set.

Since:

2026.1.0

getPorts

public List<String> getPorts()

Gets the ports on this slave client.

Returns:

The list of ports on this slave client.

Since:

2022.1.0

setPorts

public void setPorts(ArrayList<String> ports)

Sets the logical ports on this slave client.

Parameters:

ports - The logical ports to set.

Since:

2026.1.0

addPort

public void addPort(String port)

Adds a logical port to this slave client.

Parameters:

port - The logical port to add.

Since:

2026.1.0

removePort

public void removePort(String port)

Removes a logical port from this slave client.

Parameters:

port - The logical port to remove.

Since:

2026.1.0

getSysAddresses

public List<Pair<String,String>> getSysAddresses()

Gets the system address ranges for this slave client.

Returns:

The system address ranges for this slave client.

Since:

2026.1.0

addSysAddress

public void addSysAddress(String base,
                          String size)

Adds a system address range to this slave client.

Parameters:

base - The base address for the range.

size - The size of the range.

Since:

2026.1.0

removeSysAddress

public void removeSysAddress(String base)

Removes a system address range from this slave client by base address.

Parameters:

base - The base address of the range to remove.

Since:

2026.1.0

getPortDestIDMap

public Map<String,Integer> getPortDestIDMap()

Gets the map of logical ports to destination IDs.

Returns:

The map of logical ports to destination IDs.

Since:

2026.1.0

getPortDestID

public int getPortDestID(String portName)

Gets the destination ID for a logical port.

Parameters:

portName - The logical port name.

Returns:

The destination ID for the logical port.

Since:

2026.1.0

setPortDestIDMap

public void setPortDestIDMap(Map<String,Integer> portDestIDs)

Sets the map of logical ports to destination IDs.

Parameters:

portDestIDs - The map of logical ports to destination IDs.

Since:

2026.1.0

setPortDestID

public void setPortDestID(String portName,
                          int destID)

Sets the destination ID for a logical port.

Parameters:

portName - The logical port name.

destID - The destination ID to set.

Since:

2026.1.0

getInterleaveSize

public int getInterleaveSize()

Gets the interleave size in bytes.

Returns:

The interleave size in bytes.

Since:

2026.1.0

setInterleaveSize

public void setInterleaveSize(int bytes)

Sets the interleave size in bytes.

Parameters:

bytes - The interleave size in bytes.

Since:

2026.1.0

toJSONObject

public org.json.JSONObject toJSONObject()

Converts this slave client to its JSON representation.

Overrides:

toJSONObject in class NOCClient

Returns:

The JSON representation of this slave client.

Since:

2026.1.0

getConnectionFrom

public NOCConnection getConnectionFrom(String masterName)

Gets the corresponding connection based on master client name.

Parameters:

masterName - The name of the master client that connects to this slave.

Returns:

The connection between the provided master client name and this slave or null if none found.

Since:

2022.1.0