Changes between Version 3 and Version 4 of icu_device_api

Timestamp:

Nov 3, 2016, 7:54:45 PM (8 years ago)

Author:

alain

Comment:

--

icu_device_api

@@ -1 @@
-= ICU generic device API =
+= ICU device API =
 
 [[PageOutline]]
@@ -5 +5 @@
  == A) General principles ==
 
-The ICU (Interrupt Controller Unit) device is an ''internal'' peripheral, distributed in all clusters containing cores.
-He is in charge of concentrating all IRQs (interrupt request)  generated by the - internal or external - peripherals to signal the completion of a given I/O operation, and routing each IRQ to the core that started the I/O operation. He is also in charge of helping the kernel to select the ISR (Interrupt Service Routine) to be executed by the target core.
+The ICU (Interrupt Controller Unit) generic device describes an ''internal'' peripheral, acting in all clusters containing cores.
+He is in charge of concentrating all IRQs (interrupt request)  generated by the - internal or external - peripherals to signal the completion of the  I/O operation started by a core in a given cluster. Each IRQ should be routed to the core that started the I/O operation. The ICU device must also help the kernel to select the ISR (Interrupt Service Routine) that must be executed by the target core.
 
-This component can be implemented as a dedicated hardware, distributed in all clusters, or emulated in software,
+This component can be implemented as a dedicated hardware, centralized or distributed in all clusters, or emulated in software,
 as long as it implements the API defined below.
 
@@ -39 +39 @@
 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 ) ===
+=== 2) '''error_t dev_icu_enable_irq'''( uint32_t   irq_type , uint32_t   irq_id , xptr_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.
@@ -51 +51 @@
 It returns 0 if success / returns EINVAL if illegal arguments.
 
- 
+=== 4) '''error_t dev_icu_set_period'''( core_t   * core , uint32_t   pti_id , uint32_t   period ) ===
 
+This  function set the period value for a PTI timer identified by its index in the local ICU device descriptor.
+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.
 
-/*****************************************************************************************
- * This blocking function set the period value for a timer identified by the PTI index
- * in the local ICU device descriptor.
- *****************************************************************************************
- * @ pti_id    : PTI index.
- * @ period    : number of cycles.
- * @ return 0 if success / returns EINVAL if illegal arguments.
- ****************************************************************************************/
-error_t dev_icu_set_period( core_t   * core,
-                            uint32_t   pti_id,
-                            uint32_t   period );
 
 /*****************************************************************************************