Skip to content

M
Mock Turtle
Commit 397fa396 authored by Federico Vaga's avatar Federico Vaga
Browse files
Options

sw:fw: API clarification 

Signed-off-by: Federico Vaga's avatarFederico Vaga <federico.vaga@cern.ch>
parent dc4c03df
Hide whitespace changes
Inline Side-by-side
Showing with 10 additions and 6 deletions
software/firmware/lib/mockturtle-rt.h
View file @ 397fa396
......@@ -256,8 +256,8 @@ static inline unsigned int gpio_status(int pin)
}
/**
* Wait n cycles. This means that the wait can be different on
* different core with different clock.
* Wait n CPU cycles. This means that the absolute wait time can be different
* on different cores with different clock frequencies.
* @todo: use Timing Unit, compute it accoring to CPU frequency
* @param[in] n number of cycles to wait
*/
......@@ -554,7 +554,8 @@ static inline void mq_map_in_message(enum trtl_mq_type type,
/**
* Get the current MQ input status
* @param[in] type MQ type to use
* @param[in] mask bitmask to set the bit of interest
* @param[in] mask bitmask to set the bit of interest that corresponds
* to a MQ number
* @return message queues input status bitmask
*/
static inline uint32_t mq_poll_in(enum trtl_mq_type type, uint32_t mask)
......@@ -572,7 +573,8 @@ static inline uint32_t mq_poll_in(enum trtl_mq_type type, uint32_t mask)
/**
* Get the current MQ output status
* @param[in] type MQ type to use
* @param[in] mask bitmask to set the bit of interest
* @param[in] mask bitmask to set the bit of interest that corresponds
* to a MQ number
* @return message queues output status bitmask
*/
static inline uint32_t mq_poll_out(enum trtl_mq_type type, uint32_t mask)
......@@ -591,7 +593,8 @@ static inline uint32_t mq_poll_out(enum trtl_mq_type type, uint32_t mask)
/**
* Get the current MQ input status
* @param[in] type MQ type to use
* @param[in] mask bitmask to set the bit of interest
* @param[in] mask bitmask to set the bit of interest that corresponds
* to a MQ number
* @param[in] us_timeout timeout in micro-seconds
* @return message queues input status bitmask, 0 on timeout
*/
......@@ -615,7 +618,8 @@ static inline uint32_t mq_poll_in_wait(enum trtl_mq_type type, uint32_t mask,
/**
* Get the current MQ input status
* @param[in] type MQ type to use
* @param[in] mask bitmask to set the bit of interest
* @param[in] mask bitmask to set the bit of interest that corresponds
* to a MQ number
* @param[in] us_timeout timeout in micro-seconds
* @return message queues input status bitmask, 0 on timeout
*/
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment