diff --git a/quad/src/quad_app/hw_iface.h b/quad/src/quad_app/hw_iface.h index bbd6bb6fc14171d0f506151a1b87bffb9b869b21..bde0aa3f8170f465e8ab33be4576804850abfee8 100644 --- a/quad/src/quad_app/hw_iface.h +++ b/quad/src/quad_app/hw_iface.h @@ -1,6 +1,20 @@ #ifndef HW_IFACE_H #define HW_IFACE_H +/** + * Hardware Interfaces + * + * These interfaces are used to accomplish separation between the application + * layer and the hardware layer in the program that runs on the quadcopter. + * + * NOTE: + * If you wound up here after following some IDE function declaration trail, + * you've hit the end of the application layer. Go to the location of the + * hardware layer appropriate for your circumstance:p + * ../../xsdk_worksapce/modular_quad_pid -> running quad_app on the Zybo + * ../virt_quad -> running quad_app in a Unix environment + */ + struct I2CDriver { void *state; int (*reset)(struct I2CDriver *self);