Changes between Version 5 and Version 6 of xcu_driver

Timestamp:

Mar 13, 2015, 5:27:03 PM (9 years ago)

Author:

alain

Comment:

--

xcu_driver

@@ -23 +23 @@
 The addressable registers map is defined [source:soft/giet_vm/giet_drivers/xcu_driver.h here].
 
+ == __Access Functions__ ==
+
  === void '''_xcu_set_mask'''( unsigned int cluster_xy,  unsigned int channel,    unsigned int mask,   unsigned int irq_type ) ===
-This function set the mask register for the IRQ type defined by "irq_type",
-and for the channel identified by the "cluster_xy" and "channel" arguments.
-All '1' bits are set / all '0' bits are not modified.
+This function set the mask register for all IRQs of a given type. 
+ * '''cluster_xy''' : cluster coordinates.
+ * '''channel''' : XCU channel (output IRQ index).
+ * '''mask''' : mask value : All '1' bits are set / all '0' bits are not modified.
+ * '''irq_type''' : IRQ type.
 
  === void '''_xcu_get_index'''( unsigned int   cluster_xy,   unsigned int   channel,   unsigned int * index,  unsigned int * irq_type ) ===
-This function returns the index and the type of the highest priority active interrupt:
-1. active PTI (Timer Interrupt),
-2. active HWI (Hardware Interrupt),
-3. active WTI (Software Interrupt)
+ * '''cluster_xy''' : cluster coordinates.
+ * '''channel''' : XCU channel (output IRQ index).
+ * '''index''' : pointer on the index buffer.
+ * '''irq_type''' : pointer on the IRQ type buffer.
+This function returns the index and the type of the highest priority active interrupt with the following priorities: PTI > HWI > WTI.
 
  === void '''_xcu_send_wti'''( unsigned int cluster_xy,   unsigned int wti_index,   unsigned int wdata ) ===
-This function writes the ''wdata'' value in the mailbox defined by the ''cluster_xy'' and ''wti_inde'' arguments.
+This function writes a 32 bits word in a WTI mailbox.
+ * '''cluster_xy''' : cluster coordinates.
+ * '''wti_index''' : mailbox index.
+ * '''wdata''' : written value.
 
  === void '''_xcu_get_wti_value'''( unsigned int   cluster_xy,   unsigned int   wti_index,   unsigned int * value ) ===
-This function returns the value contained in a WTI mailbox defined by the ''cluster_xy'' and ''wti_index'' arguments. This value is written in the ''value'' argument, and the corresponding WTI is acknowledged.
+This function returns the value contained in a WTI mailbox. The corresponding WTI is acknowledged.
+ * '''cluster_xy''' : cluster coordinates.
+ * '''wti_index''' : mailbox index.
+ * '''value''' : pointer on the destination buffer.
 
  === void '''_xcu_get_wti_address'''( unsigned int   wti_index,  unsigned int * address ) ===
-This function returns the physical address of the WTI mailbox in cluster [0][0], defined by the ''wti_index'' argument, in the ''address'' argument.
-It is used by the GIET to configurate the IOPIC component. There is no access to a specific XCU component in a specific cluster.
+This function returns the physical address (32 LSB bits) of the WTI mailbox identified by its index.
+There is no access to a specific XCU component in a specific cluster.
+ * '''wti_index''' : WTI index.
+ * '''address''' : pointer on the destination buffer.
 
  === void '''_xcu_timer_start'''( unsigned int cluster_xy,   unsigned int pti_index,  unsigned int period ) === 
 This function activates a timer contained in XCU by writing in the proper register the period value.
+ * '''cluster_xy''' : cluster coordinates.
+ * '''pti_index''' : mailbox index.
+ * '''period''' : period value.
 
  === void '''_xcu_timer_stop'''( unsigned int cluster_xy,   unsigned int pti_index ) === 
 This function desactivates a timer in XCU component by writing in the proper register.
+ * '''cluster_xy''' : cluster coordinates.
+ * '''pti_index''' : mailbox index.
 
- === unsigned int '''_xcu_timer_reset_irq'''( unsigned int cluster_xy,   unsigned int pti_index ) ===
+ === void '''_xcu_timer_reset_irq'''( unsigned int cluster_xy,   unsigned int pti_index ) ===
 This function acknowlegge a timer interrupt in XCU component by reading in the proper XCU register.
 It is used by both the isr_switch() for a system timer,  or by the _isr_timer() for an user timer.
+ * '''cluster_xy''' : cluster coordinates.
+ * '''pti_index''' : mailbox index.
 
  === void '''_xcu_timer_reset_cpt'''( unsigned int cluster_xy,  unsigned int pti_index ) ===
-This function resets a timer counter. To do so, it read in the TIMER_PERIOD register, and rewrite the same value in the same register,
-what causes the count to restart. This function is called during a context switch (user or preemptive).
+This function resets a timer counter. To do so, it read in the TIMER_PERIOD register, and rewrite the same value in the same register, what causes the count to restart. This function is called during a context switch (user or preemptive).
+ * '''cluster_xy''' : cluster coordinates.
+ * '''pti_index''' : mailbox index.