Changes between Version 2 and Version 3 of icu_device_api

Timestamp:

Nov 3, 2016, 7:40:24 PM (7 years ago)

Author:

alain

Comment:

--

icu_device_api

@@ -32 +32 @@
 == B) Access Functions ==
 
-=== '''void dev_icu_init'''( device_t * icu ) === 
+=== 1) '''void dev_icu_init'''( device_t * icu ) === 
 
 This function makes two initialisations: It initialises the ICU specific fields of the device descriptor.
 it initialises the implementation specific ICU hardware device and associated data structures if required.
 It must be executed once by a thread running in the cluster containing the ICU device descriptor.
- *****************************************************************************************
- * @ dev     : pointer on ICU device descriptor.
- ****************************************************************************************/
-void dev_icu_init( device_t * icu );
+The <icu> argument is a local pointer on the ICU device descriptor.
+ 
+=== 2) '''error_t dev_icu_enable_irq'''( uint32_t   irq_type , uint32_t   irq_id , device_t * src_dev ) ===
 
-/*****************************************************************************************
- * This blocking function enable one IRQ defined by its type (HWI/WTI/PTI) and index 
- * in the local ICU device descriptor, and register it in the proper interrupt vector
- * of the calling core.
- *****************************************************************************************
- * @ irq_type  : HWI/WTI/PTI.
- * @ irq_id    : IRQ index.
- * @ device    : pointer on device descriptor source of IRQ.
- * @ returns 0 if success / returns EINVAL if illegal arguments.
- ****************************************************************************************/
-error_t dev_icu_enable_irq( uint32_t   irq_type,
-                            uint32_t   irq_id,
-                            device_t * src_dev );
+This function must be executed by a thread running in the cluster containing the ICU device descriptor. It enables one IRQ defined by its type and index for the calling core, and register it in the interrupt vector.
+The <irq_type> and <irq_id> arguments define the IRQ type and index. The <src_dev> argument is the remote pointer on the source device.
+It returns 0 if success / returns EINVAL if illegal arguments.
 
-/*****************************************************************************************
- * This blocking function disable one IRQ defined by its type (HWI/WTI/PTI) and index
- * in the local ICU device descriptor, and remove it from the proper interrupt vector
- * of the calling core.
- *****************************************************************************************
- * @ irq_type  : HWI/WTI/PTI.
- * @ irq_id    : IRQ index.
- * @ returns 0 if success / returns EINVAL if illegal arguments.
- ****************************************************************************************/
-error_t dev_icu_disable_irq( uint32_t   irq_type,
-                             uint32_t   irq_id );
-                        
+=== 3) '''error_t dev_icu_disable_irq'''( uint32_t   irq_type , uint32_t   irq_id ) ===
+
+This function must be executed by a thread running in the cluster containing the ICU device descriptor. It disables one IRQ defined by its type and index, for the calling core, and remove it from the interrupt vector.
+The <irq_type> and <irq_id> arguments define the IRQ type and index.
+It returns 0 if success / returns EINVAL if illegal arguments.
+
+ 
+
+
 /*****************************************************************************************
  * This blocking function set the period value for a timer identified by the PTI index
@@ -102 +88 @@
  ****************************************************************************************/
 void dev_icu_irq_handler();
-