Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changed type and view naming #12

Merged
merged 2 commits into from
Jul 5, 2020
Merged

Changed type and view naming #12

merged 2 commits into from
Jul 5, 2020

Conversation

Paebbels
Copy link
Member

@Paebbels Paebbels commented Jul 4, 2020

This PR addresses #10.

  • T_... that we use _Interface or Interface for interface types
    Applied change: using _Interface

  • T_... that we use something that is understood naturally without a secret decoder ring.
    Applied change: currently, there are no ordinary types in the packages, all are records defining an interface.

  • V_... that we use _View or View
    Applied change: using _View

  • For ..._In also consider In as suffix (w/o _).
    "In" follows main data flow. Similar thoughts for ...Out

    • Like: I2C_InView vs. I2CViewIn vs. I2CView_In
    • No Like: I2CInView vs. I2C_In_View vs. I2C_View_In

    Applied change: using _InView and _OutView respectively.

  • For each interface there shall be a vector of that interface also declared of the form: _Interface_Vector
    Applied change: requirement was already fulfilled

  • _PCB vs FPGA Internals
    Applied change: PCB related signals use suffix _PCB, which fabric signal have no suffix.

  • Review naming for AddressBus which historically was Master/Initiator and Slave/Target
    Applied change: Different names chooses, if not dictated by the standard itself. If the standard changes naming, these definitions can be changed too.

  • AxiAddress should be unsigned.
    Applied change: AXI is not part of this repo yet, will be applied when AXI is uploaded.


/cc @JimLewis see changes

@Paebbels Paebbels changed the base branch from master to dev July 4, 2020 23:35
@Paebbels Paebbels self-assigned this Jul 4, 2020
@Paebbels Paebbels mentioned this pull request Jul 4, 2020
@Paebbels Paebbels requested a review from JimLewis July 4, 2020 23:41
@Paebbels Paebbels added the Enhancement New feature or request label Jul 4, 2020
@Paebbels Paebbels added this to the Prepare first release milestone Jul 5, 2020
@Paebbels
Copy link
Member Author

Paebbels commented Jul 5, 2020

The new style looks much more user friendly and readable.

@Paebbels Paebbels merged commit e8fb5bc into dev Jul 5, 2020
@Paebbels Paebbels deleted the naming branch July 5, 2020 10:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant