Northeastern-Electric-Racing / Cerberus

Our FreeRTOS-based vehicle control application
1 stars 0 forks source link

[Formatting] - Standardize Interfaces for Intialization between Interfaces and Drivers #121

Closed nwdepatie closed 3 months ago

nwdepatie commented 6 months ago

Spike Type

Technical

Goal

Right now there are many different ways that we initialize and retrieve data from drivers. Sometimes you modify a struct then pass it in, sometimes you retrieve a struct that was malloc'ed from within the function, sometimes you pass in an empty struct and it gets filled. We should look into the benefits and drawbacks of each and figure out which is the best, then implement the interface for:

  1. Cerberus Interfaces
  2. Embedded Base Drivers and Middleware
  3. Other firmware applications

Reason for Spike

All of the inconsistent interfaces are not terrible to work with but it would make the code a lot more readable and predictable when writing it, especially because we control all these interfaces.

Additional notes

No response