Port Naming Convention

The IP Core port naming convention follows this template:

<Shorthand for endpoint type><Endpoint address in hexadecimal>_ep_<Endpoint Signal>

  • See USB 3.0 HDL for descriptions of the Endpoint Signals.
  • See the Naming Convention Benefits Discussion which encourages the naming convention beyond the IP instantiation.
  • See the following instantiation template for an example of the port naming on each of the Endpoint types:
frontpanel_example your_instance_name ( .okUH(okUH), // input wire [4 : 0] okUH .okHU(okHU), // output wire [2 : 0] okHU .okUHU(okUHU), // inout wire [31 : 0] okUHU .okAA(okAA), // inout wire okAA .okClk(okClk), // output wire okClk .wi00_ep_dataout(wi00_ep_dataout), // output wire [31 : 0] wi00_ep_dataout .wo20_ep_datain(wo20_ep_datain), // input wire [31 : 0] wo20_ep_datain .ti40_ep_trigger(ti40_ep_trigger), // output wire [31 : 0] ti40_ep_trigger .ti40_ep_clk(ti40_ep_clk), // input wire ti40_ep_clk .to60_ep_trigger(to60_ep_trigger), // input wire [31 : 0] to60_ep_trigger .to60_ep_clk(to60_ep_clk), // input wire to60_ep_clk .pi80_ep_dataout(pi80_ep_dataout), // output wire [31 : 0] pi80_ep_dataout .pi80_ep_write(pi80_ep_write), // output wire pi80_ep_write .btpi81_ep_dataout(btpi81_ep_dataout), // output wire [31 : 0] btpi81_ep_dataout .btpi81_ep_write(btpi81_ep_write), // output wire btpi81_ep_write .btpi81_ep_blockstrobe(btpi81_ep_blockstrobe), // output wire btpi81_ep_blockstrobe .btpi81_ep_ready(btpi81_ep_ready), // input wire btpi81_ep_ready .poa0_ep_datain(poa0_ep_datain), // input wire [31 : 0] poa0_ep_datain .poa0_ep_read(poa0_ep_read), // output wire poa0_ep_read .btpoa1_ep_datain(btpoa1_ep_datain), // input wire [31 : 0] btpoa1_ep_datain .btpoa1_ep_read(btpoa1_ep_read), // output wire btpoa1_ep_read .btpoa1_ep_blockstrobe(btpoa1_ep_blockstrobe), // output wire btpoa1_ep_blockstrobe .btpoa1_ep_ready(btpoa1_ep_ready), // input wire btpoa1_ep_ready .regbridge_ep_write(regbridge_ep_write), // output wire regbridge_ep_write .regbridge_ep_read(regbridge_ep_read), // output wire regbridge_ep_read .regbridge_ep_address(regbridge_ep_address), // output wire [31 : 0] regbridge_ep_address .regbridge_ep_dataout(regbridge_ep_dataout), // output wire [31 : 0] regbridge_ep_dataout .regbridge_ep_datain(regbridge_ep_datain) // input wire [31 : 0] regbridge_ep_datain );
Code language: JavaScript (javascript)