source: trunk/kernel/devices/dev_pic.h @ 503

Last change on this file since 503 was 503, checked in by viala@…, 3 years ago

Add void type on function that takes no parameters, fix invalid call.

Fix invalid calls to thread_can_yield.

In file included from kern/chdev.c:29:
kern/chdev.c: In function 'chdev_sequencial_server':
kern/chdev.c:329:21: error: too many arguments to function 'thread_can_yield'

assert( thread_can_yield( server ) , "illegal sched_yield\n" );

~

Also fixed signature of mapper_create.

File size: 13.6 KB
Line 
1/*
2 * dev_pic.h - PIC (Programmable Interrupt Controler) generic device API definition.
3 *
4 * Authors   Alain Greiner  (2016,2017,2018)
5 *
6 * Copyright (c) UPMC Sorbonne Universites
7 *
8 * This file is part of ALMOS-MKH.
9 *
10 * ALMOS-MKH is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; version 2.0 of the License.
13 *
14 * ALMOS-MKH is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17 * General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with ALMOS-MKH; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 */
23
24#ifndef _DEV_PIC_H_
25#define _DEV_PIC_H_
26
27#include <kernel_config.h>
28#include <hal_kernel_types.h>
29
30/*****************************************************************************************
31 *     Generic Programmable Interrupt Controler definition
32 *
33 * The PIC generic device describes the the programmable hardware infrastructure used
34 * to route a given IRQ to a given core, in a given cluster, and to help the interrupt
35 * handler to select  and execute the relevant ISR (Interrupt Service Routine).
36 * It handles the four following types of interrupts:
37 *
38 * 1) EXT_IRQ (External IRQ) generated by the external (shared) peripherals.
39 * 2) INT_IRQ (Internal IRQ) generated by the internal (replicated) peripherals.
40 * 3) TIM_IRQ (Timer IRQ) generated by the timers (one timer per core).
41 * 4) IPI_IRQ (Inter Processor IRQ) generated by software (one IPI per core).
42 *
43 * In supported manycores architectures, the PIC device contains two types
44 * of hardware components:
45 * - the IOPIC is an external component, handling all external peripherals IRQs.
46 * - The LAPIC is an internal component, replicated in each cluster, handling local
47 *   peripherals IRQS, Timer IRQs and IPIs (inter-processor-interupts).
48 *
49 * The "source" device for each input IRQ to the external IOPIC component, is defined
50 * in the "arch_info" file, and registered in the "iopic_input" global variable
51 * at kernel initialization.
52 *
53 * The "source" device for each input IRQ to the replicated LAPIC components, is defined
54 * in the "arch_info" file, and stored in the "lapic_input" global variable
55 * at kernel initialization.
56 *
57 * The PIC device defines generic commands that can be used by each kernel instance,
58 * - to create in local cluster the PIC implementation specific interupt vector(s),
59 * - to bind a given IRQ (internal or external IRQ to a given core in the local cluster,
60 * - to configure and activate the TICK timer for a given core in the local cluster,
61 * - to allows the software to send an IPI to any core in any cluster.
62 * This API is detailed below, and must be implemented by all PIC implementations.
63 *
64 * In each cluster, a PIC implementation specific structure can be linked to the
65 * cluster manager or to the core descriptors to register the interrupt vectors
66 * used by the kernel to select the relevant ISR when an interrupt is received
67 * by a given core in a given cluster.
68 
69 * This PIC device does not execute itself I/O operations. It is just acting as a
70 * configurable interrupt router for I/O operation executed by other peripherals.
71 * Therefore, ALMOS-MKH does not use the PIC device waiting queue, does not creates
72 * a server thread for the PIC device, and does not register the command in the calling
73 * thread descriptor, but call directly the relevant driver function.
74 ****************************************************************************************/
75 
76/****  Forward declarations  ****/
77
78struct chdev_s;
79
80/*****************************************************************************************
81 * This defines the specific extension for the PIC chdev descriptor.
82 * It contains the function pointers for all functions that mus be implemented
83 * by all implementation specific drivers.
84 ****************************************************************************************/
85
86typedef void   (bind_irq_t)     ( lid_t lid , struct chdev_s * src_chdev );
87typedef void   (enable_irq_t)   ( lid_t lid , xptr_t src_chdev_xp );
88typedef void   (disable_irq_t)  ( lid_t lid , xptr_t src_chdev_xp );
89typedef void   (enable_timer_t) ( uint32_t period );
90typedef void   (enable_ipi_t)   ( void );
91typedef void   (send_ipi_t)     ( cxy_t cxy , lid_t lid );
92typedef void   (ack_ipi_t)      ( void );
93typedef void   (extend_init_t)  ( uint32_t * lapic_base );
94 
95typedef struct pic_extend_s
96{
97    bind_irq_t      * bind_irq;      /*! pointer on the driver "bind_irq" function      */ 
98    enable_irq_t    * enable_irq;    /*! pointer on the driver "enable_irq" function    */ 
99    disable_irq_t   * disable_irq;   /*! pointer on the driver "disable_irq" function   */ 
100    enable_timer_t  * enable_timer;  /*! pointer on the driver "enable_timer" function  */
101    enable_ipi_t    * enable_ipi;    /*! pointer on the driver "enable_ipi" function    */
102    send_ipi_t      * send_ipi;      /*! pointer on the driver "send_ipi" function      */
103    ack_ipi_t       * ack_ipi;       /*! pointer on the driver "ack_ipi" function       */
104    extend_init_t   * extend_init;   /*! pointer on the driver "init_extend" function   */
105}
106pic_extend_t;
107
108/*****************************************************************************************
109 * This structure defines the input IRQS for the external IOPIC controller, that is used
110 * by external peripherals (IOC, NIC, TXT, etc.) to signal completion of an I/O operation.
111 * It describes the hardware wiring of IRQs between external peripherals and the IOPIC,
112 * as each entry contains the input IRQ index in IOPIC.
113 * For a multi-channels/multi_IRQ peripheral, there is one chdev per IRQ.
114 * This structure is replicated in each cluster. It is allocated as a global variable
115 * in the kernel_init.c file.
116 *****************************************************************************************/
117
118typedef struct iopic_input_s
119{
120    uint32_t   ioc[CONFIG_MAX_IOC_CHANNELS];
121    uint32_t   txt_rx[CONFIG_MAX_TXT_CHANNELS];
122    uint32_t   txt_tx[CONFIG_MAX_TXT_CHANNELS];
123    uint32_t   nic_rx[CONFIG_MAX_NIC_CHANNELS];
124    uint32_t   nic_tx[CONFIG_MAX_NIC_CHANNELS];
125    uint32_t   iob;
126}
127iopic_input_t;
128
129/******************************************************************************************
130 * This structure defines the input IRQS for the internal LAPIC controllers, that are used
131 * by internal peripherals IRQS (DMA, MMC) to signal completion of an I/O operation.
132 * It describes the hardware wiring of IRQs between internal peripherals and ICU,
133 * as each entry contains the input IRQ index in the LAPIC component.
134 * For a multi-channels peripheral, there is one chdev and one IRQ per channel.
135 * This structure is replicated in each cluster. It is allocated as a global variable
136 * in the kernel_init.c file.
137 *****************************************************************************************/
138
139typedef struct lapic_input_s
140{
141    uint32_t   dma[CONFIG_MAX_DMA_CHANNELS];
142    uint32_t   mmc;                             // MMC is single channel
143}
144lapic_input_t;
145
146/*****************************************************************************************
147 * This enum defines the various implementations of the PIC device.
148 * This array must be kept consistent with the define in arch_info.h file
149 ****************************************************************************************/
150
151enum pic_impl_e
152{
153    IMPL_PIC_SCL =   0,     
154    IMPL_PIC_I86 =   1,
155}
156pic_impl_t;
157
158/*****************************************************************************************
159 * This function makes two initialisations :
160 * - It initializes the PIC specific fields of the chdev descriptor.
161 * - it initializes the implementation specific PIC hardware registers.
162 * It is executed once in cluster containing the PIC chdev, during kernel initialisation.
163 * The calling core goes to sleep in case of failure.
164 *****************************************************************************************
165 * @ pic        : local pointer on PIC device descriptor.
166 ****************************************************************************************/
167void dev_pic_init( struct chdev_s * pic );
168
169/*****************************************************************************************
170 * This function completes the PIC infrastructure initialisation in each cluster.
171 * It allocates memory for the local PIC extensions in the core descriptors and/or
172 * in the cluster manager, as required by the specific PIC implementation.
173 * This function is called by CPO in all clusters, during kernel initialisation phase.
174 * The calling core goes to sleep in case of failure.
175 *****************************************************************************************
176 * @ lapic_base  : local pointer on LAPIC component segment base.
177 ****************************************************************************************/
178void dev_pic_extend_init( uint32_t * lapic_base );
179
180/*****************************************************************************************
181 * This function configure the PIC device to route the IRQ generated by a local chdev,
182 * defined by the <src_chdev> argument, to a local core identified by the <lid> argument.
183 * This is a static binding, defined during kernel init: IRQ can be enabled/disabled,
184 * but the binding cannot be released. It can be used for both internal & external IRQs.
185 * The configuration is actually done by the - implementation specific - driver,
186 * and this function just call the relevant driver.
187 * WARNING : the IRQ must be explicitely enabled by the dev_pic_enable_irq() function.
188 *****************************************************************************************
189 * @ lid        : target core local index.
190 * @ src_chdev  : local pointer on source chdev descriptor.
191 ****************************************************************************************/
192void dev_pic_bind_irq( lid_t            lid,
193                       struct chdev_s * src_chdev );
194
195/*****************************************************************************************
196 * This function enables the IRQ generated by a remote chdev, defined by the
197 * <src_chdev_xp> argument. It can be called by any thread running in any cluster,
198 * and can be used for both internal & external IRQs.
199 *****************************************************************************************
200 * @ lid           : target core local index (in cluster containing the source chdev).
201 * @ src_chdev_xp  : extended  pointer on source chdev descriptor.
202 ****************************************************************************************/
203void dev_pic_enable_irq( lid_t   lid,
204                         xptr_t  src_chdev_xp );
205
206/*****************************************************************************************
207 * This function disables remote IRQ generated by a remote chdev, defined by the
208 * <src_chdev_xp> argument. It can be called by any thread running in any cluster,
209 * and can be used for both INT_IRq & EXT_IRQ.
210 *****************************************************************************************
211 * @ lid           : target core local index (in cluster containing the source chdev).
212 * @ src_chdev_xp  : extended pointer on sour chdev descriptor.
213 ****************************************************************************************/
214void dev_pic_disable_irq( lid_t   lid,
215                          xptr_t  src_chdev_xp );
216
217/*****************************************************************************************
218 * This function activates the TIM_IRQ for the calling core.
219 * The <period> argument is a number of milli-seconds between two successive IRQs.
220 * It is converted to a number of cycles by the PIC driver implementation.
221 *****************************************************************************************
222 * @ period      : number of milliseconds.
223 ****************************************************************************************/
224void dev_pic_enable_timer( uint32_t period );
225
226/*****************************************************************************************
227 * This function activates the IPI_IRQ for the calling core.
228 ****************************************************************************************/
229void dev_pic_enable_ipi( void );
230
231/*****************************************************************************************
232 * This function allows the calling thread to send an IPI to any core in any cluster.
233 * The target core is identified by the <cxy> & <lid> arguments.
234 *****************************************************************************************
235 * @ cxy        : target core cluster.
236 * @ lid        : target core local index.
237 ****************************************************************************************/
238void dev_pic_send_ipi( cxy_t  cxy,
239                       lid_t  lid );
240
241/*****************************************************************************************
242 * This function acknowledges the IPI identified by the calling core local index,
243 * in the local LAPIC component.
244 ****************************************************************************************/
245void dev_pic_ack_ipi( void );
246
247/*****************************************************************************************
248 * This debug function displays the content of the iopic_input structure,
249 * that register the input IRQS for the external IOPIC controller.
250 ****************************************************************************************/
251void dev_pic_inputs_display( void );
252
253#endif  /* _DEV_PIC_H_ */
Note: See TracBrowser for help on using the repository browser.