Skip to content

Conversation

@XyzalAxel
Copy link

Added setups for AXI files and the Markdown file for AXI Crossbar. Implemented the one-pager by mapping each required documentation section directly onto the structure of the axi_crossbar module (Purpose & Role, Parameters, Ports, etc.). Also, using AMD's documentation regarding AXI Interconnect as a resource.

@XyzalAxel XyzalAxel self-assigned this Nov 14, 2025
@XyzalAxel XyzalAxel added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 14, 2025
@XyzalAxel XyzalAxel changed the title Initial PR for Bus System Initial AXI Module skeleton Nov 14, 2025
input logic s_rst_ni,

// Destination clock domain
input logic m_clck_i,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Label Consistency: "m_clck_i" -> "m_clk_i"

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

)(
// TODO: add ports
input logic clk_i,
input logic rst_ni
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Syntax Error: Add comma after port declaration

Copy link
Collaborator

@Meowcaroni Meowcaroni left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@XyzalAxel Please review comments, make changes accordingly, and resubmit PR (pull request).

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Syntax Error: Parameters should be listed with commas, not semicolons. Write in following style:
parameter int unsigned A = 1,
parameter int unsigned B = 2

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Syntax Error: Parameters should be listed with commas, not semicolons. Write in following style:
parameter int unsigned A = 1,
parameter int unsigned B = 2

Comment on lines +53 to +55
function automatic logic [PTR_SIZE-1:0] BinaryToGray(input logic [PTR_SIZE-1:0] binary);
BinaryToGray = (binary >> 1) ^ binary;
endfunction
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reference Call Error: Function is named "BinaryToGray" while references are named"binaryToGray". Make sure to update output variable within function as well if function name is changed.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Style Issue: Move "begin" keywords to same lines associated components (always, if, etc.)

parameter int unsigned N_S = 2,
parameter int unsigned ADDR_WIDTH = 32,
parameter int unsigned DATA_WIDTH = 64,
parameter int unsigned ID_WIDTH = 4,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Syntax Error: Extra comma

Copy link
Collaborator

@Meowcaroni Meowcaroni left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall pretty good, just minor syntax & style issues. Beyond what I already wrote, please leave anything that won't synthesize (EX: Writing "ports" with no definition) in comments in case someone is running simulations with all the files.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants