Changes between Version 4 and Version 5 of icu_device_api

Timestamp:

Nov 4, 2016, 11:47:30 AM (9 years ago)

Author:

alain

Comment:

--

icu_device_api

@@ -27 +27 @@
 Each entry in one interrupt vector array (defining one IRQ type and index) contains an extended pointer on the device descriptor that is the "source" of the interrupt. This device descriptor contains a link to the ISR to be executed to handle the interrupt event. 
 
-The generic ICU device working for a single client that is the local kernel instance, it does not use the device descriptor  queue.
-All commands are immediately executed, and use the device lock to get exclusive access to the ICU device state.
+As the generic ICU device works for a single client (the local kernel instance), it does not use the device descriptor  queue.
+All commands are immediately executed, using the device lock to get exclusive access to the ICU device state.
 
 == B) Access Functions ==
@@ -56 +56 @@
 The <core> argument is local pointer on the target core. The <pti_id> argument is the timer index. 
 The <period> argument is the period value (number of cycles).
-It return 0 if success / returns EINVAL if illegal arguments.
+It returns 0 if success / returns EINVAL if illegal arguments.
 
+=== 5) '''error_t dev_icu_send_ipi'''( cxy_t    cxy , lid_t    lid ) ===
 
-/*****************************************************************************************
- * This function send an IPI (Inter Processor Interrupt) to a core identified by
- * its cluster identifier and local index. 
- * This IPI force a context switch, and the handling of pending RPC(s).
- *****************************************************************************************
- * @ cxy      : destination cluster identifier.
- * @ lid      : destination core local index.
- * @ return 0 if success (IPI registered) / returns EINVAL if illegal cxy or lid.
+This function send an IPI (Inter Processor Interrupt) to a core identified by its cluster identifier and local index. 
+This IPI force a context switch, and the handling of pending RPC(s).
+The <cxy> argument is the destination cluster identifier. The <lid> argument is the  destination core local index.
+It returns 0 if success / returns EINVAL if illegal arguments.
+
+=== 6) '''void dev_icu_irq_handler'''() ===
+
+This function is called by a core when it receives an IRQ from the ICU device.
+It access the local ICU device descriptor to get the highest priority active IRQ of each type (HWI / WTI / PTI).
+ * If it is a WTI or an HWI, the function uses the calling core interrupt-vectors to call the relevant ISR, registered in the source device descriptor.
+ * If it is a PTI, the source device descriptor is the ICU device itself, and it call the core_clock() function to execute all operations related to the TICK event.
  ****************************************************************************************/
-error_t dev_icu_send_ipi( cxy_t    cxy,
-                          lid_t    lid );
-
-/*****************************************************************************************
- * This function is called by a core when it receives an IRQ from the ICU device.
- * It access the local ICU device descriptor to get the highest priority IRQ
- * of each type (HWI / WTI / PTI).
- * - If it is a WTI or an HWI, the function uses the calling core interrupt-vectors
- *   to call the relevant ISR, registered in the source device descriptor.
- * - If it is a PTI, the source device descriptor is the ICU device itself, and it 
- *   call the core_clock() function to execute all operations related to the TICK event.
- ****************************************************************************************/
-void dev_icu_irq_handler();