source: trunk/kernel/kern/chdev.h @ 516

Last change on this file since 516 was 485, checked in by viala@…, 6 years ago

[kern] Add void type to function prototypes with no parameter
File size: 13.7 KB
Line 
1/*
2 * chdev.h - channel device (chdev) descriptor definition.
3 *
4 * Authors  Alain Greiner    (2016)
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 _CHDEV_H_
25#define _CHDEV_H_
26
27#include <kernel_config.h>
28#include <hal_kernel_types.h>
29#include <xlist.h>
30#include <remote_spinlock.h>
31#include <dev_iob.h>
32#include <dev_ioc.h>
33#include <dev_nic.h>
34#include <dev_pic.h>
35#include <dev_fbf.h>
36#include <dev_txt.h>
37
38/******************************************************************************************
39 *       Channel Device descriptor definition
40 *
41 * This file defines the kernel representation of a generic (i.e. implementation
42 * independant) Channel Device descriptor (in brief "chdev").
43 * ALMOS-MKH supports multi-channels peripherals, and defines one separated chdev
44 * descriptor for each channel (and for each RX/TX direction for the NIC and TXT devices).
45 * Each chdev contains a waiting queue, registering the "client threads" requests,
46 * and an associated "server thread", handling these requests.
47 * These descriptors are physically distributed on all clusters to minimize contention.
48 * Therefore a given I/O operation involve generally three clusters:
49 * - the client cluster, containing the client thread,
50 * - the server cluster, containing the chdev and the server thread,
51 * - the I/O cluster, containing the physical device.
52 *****************************************************************************************/
53
54/****  Forward declarations  ****/
55
56struct  chdev_s;
57struct  thread_s;
58struct  boot_info_s;
59
60/******************************************************************************************
61 * These macros extract the functionality and the implementation from the peripheral type.
62 *****************************************************************************************/
63 
64#define FUNC_FROM_TYPE( type )    ((uint32_t)(type>>16))
65#define IMPL_FROM_TYPE( type )    ((uint32_t)(type & 0x0000FFFF))
66
67/******************************************************************************************
68 * This define the generic prototypes for the three functions that must be defined
69 * by the drivers implementing a generic device:
70 * - "cmd"     : start a blocking I/O operation.
71 * - "isr"     : complete an I/O operation.
72 * - "aux"     : not for all drivers (implement special functions)
73 * The "cmd", "isr", and "aux" driver functions are registered in the generic chdev
74 * descriptor at kernel init, and are called to start and complete an I/O operation. 
75*****************************************************************************************/
76
77typedef void (dev_ini_t) ( xptr_t dev );     
78typedef void (dev_cmd_t) ( xptr_t thread ); 
79typedef void (dev_isr_t) ( struct chdev_s * dev ); 
80typedef void (dev_aux_t) ( void * args ); 
81
82/******************************************************************************************
83 * This enum defines the supported generic device types.
84 * These types are functionnal types: all (architecture specific) implementations
85 * provide the same set of operations and the same driver API.
86 * This enum must be consistent with the enum in files arch_info.h, and arch_class.py.
87 *
88 * WARNING : The ICU device exist in boot_info to specify the base address of the
89 *           distributed LAPIC controler, but it does not exist as a chdev in the kernel,
90 *           as it is hidden in the driver associated to the PIC device.
91 *****************************************************************************************/
92 
93enum dev_func_type
94{
95        DEV_FUNC_RAM   =  0,
96        DEV_FUNC_ROM   =  1,
97        DEV_FUNC_FBF   =  2,
98    DEV_FUNC_IOB   =  3,
99    DEV_FUNC_IOC   =  4,
100        DEV_FUNC_MMC   =  5,
101        DEV_FUNC_DMA   =  6,
102        DEV_FUNC_NIC   =  7,
103        DEV_FUNC_TIM   =  8,
104        DEV_FUNC_TXT   =  9,
105    DEV_FUNC_ICU   = 10,   
106    DEV_FUNC_PIC   = 11,
107
108    DEV_FUNC_NR    = 12,
109};
110
111/******************************************************************************************
112 * This structure defines a chdev descriptor.
113 * For multi-channels device, there is one chdev descriptor per channel.
114 * This structure is NOT replicated, and can be located in any cluster.
115 * One kernel thread, in charge of handling the commands registered in the waiting queue
116 * of client threads is associated to each chdev descriptor (not for ICU, PIC, IOB).
117 * For each device type ***, the specific extension is defined in the "dev_***.h" file.
118 *****************************************************************************************/
119
120typedef struct chdev_s
121{
122        uint32_t             func;        /*! peripheral functionnal type                    */
123        uint32_t             impl;        /*! peripheral inplementation subtype              */
124    uint32_t             channel;     /*! channel index                                  */
125    bool_t               is_rx;       /*! relevant for NIC and TXT peripherals           */
126        xptr_t               base;        /*! extended pointer on channel device segment     */
127    char                 name[16];    /*! name (required by DEVFS)                       */
128
129    dev_cmd_t          * cmd;         /*! local pointer on driver CMD function           */
130    dev_isr_t          * isr;         /*! local pointer on driver ISR function           */
131    dev_aux_t          * aux;         /*! local pointer on driver AUX function           */
132
133    struct thread_s    * server;      /*! local pointer on associated server thread      */
134
135    uint32_t             irq_type;    /*! associated IRQ type in local ICU               */
136    uint32_t             irq_id;      /*! associated IRQ index in local ICU              */
137
138        remote_spinlock_t    wait_lock;   /*! lock protecting exclusive access to queue      */
139    xlist_entry_t        wait_root;   /*! root of waiting threads queue                  */
140
141    union
142    {
143        iob_extend_t     iob;         /*! IOB specific extension                         */
144        ioc_extend_t     ioc;         /*! IOC specific extension                         */
145        nic_extend_t     nic;         /*! NIC specific extension                         */
146        pic_extend_t     pic;         /*! PIC specific extension                         */
147        fbf_extend_t     fbf;         /*! FBF specific extension                         */
148        txt_extend_t     txt;         /*! TXT specific extension                         */
149    } 
150    ext;
151}
152chdev_t;
153
154/******************************************************************************************
155 * This structure defines the channel_devices descriptors directory.
156 * Each entry in this structure contains an extended pointer on a chdev descriptor.
157 * There is one entry per channel OR per cluster, depending on peripheral type.
158 * This structure is replicated in each cluster, and is initialised during kernel init.
159 * It is used for fast access to a device descriptor, from type and channel for an
160 * external peripheral, or from type and cluster for an internal peripheral.
161 * - a "shared" chdev can be accessed by any thread running in any cluster.
162 * - a "private" chdev can only be accessed by a thread running in local cluster.
163 *****************************************************************************************/
164
165typedef struct chdev_directory_s
166{
167    xptr_t   iob;                                // external / single channel / shared
168    xptr_t   pic;                                // external / single channel / shared
169
170    xptr_t   ioc[CONFIG_MAX_IOC_CHANNELS];       // external / multi-channels / shared
171    xptr_t   fbf[CONFIG_MAX_FBF_CHANNELS];       // external / multi-channels / shared
172    xptr_t   txt_rx[CONFIG_MAX_TXT_CHANNELS];    // external / multi-channels / shared
173    xptr_t   txt_tx[CONFIG_MAX_TXT_CHANNELS];    // external / multi-channels / shared
174    xptr_t   nic_rx[CONFIG_MAX_NIC_CHANNELS];    // external / multi-channels / shared
175    xptr_t   nic_tx[CONFIG_MAX_NIC_CHANNELS];    // external / multi-channels / shared
176
177    xptr_t   mmc[CONFIG_MAX_CLUSTERS];           // internal / single channel / shared
178
179    xptr_t   dma[CONFIG_MAX_DMA_CHANNELS];       // internal / multi-channels / private
180}
181chdev_directory_t;
182
183/******************************************************************************************
184 * This function display relevant values for a chdev descriptor.
185 ******************************************************************************************
186 * @ chdev   : pointer on chdev.
187 *****************************************************************************************/
188void chdev_print( chdev_t * chdev );
189
190/******************************************************************************************
191 * This function returns a printable string for a device functionnal types.
192 ******************************************************************************************
193 * @ func_type  : functionnal type.
194 * @ return pointer on string.
195 *****************************************************************************************/
196char * chdev_func_str( uint32_t func_type );
197
198/******************************************************************************************
199 * This  function allocates memory and initializes a chdev descriptor in local cluster,
200 * from arguments values.  It should be called by a local thread.
201 * The device specific fields are initialised later.
202 ******************************************************************************************
203 * @ func      : functionnal type.
204 * @ impl      : implementation type.
205 * @ channel   : channel index / for multi-channels peripherals.
206 * @ is_rx     : for NIC peripheral / NIC RX if true / NIC TX if false.
207 * @ base      : extended pointer on peripheral segment base.
208 * @ return a local pointer on created chdev / return NULL if failure.
209 *****************************************************************************************/
210chdev_t * chdev_create( uint32_t    func,
211                        uint32_t    impl,
212                        uint32_t    channel,
213                        bool_t      is_rx,
214                        xptr_t      base );
215
216/******************************************************************************************
217 * This function registers the calling thread in the waiting queue of a remote
218 * chdev descriptor, activates (i.e. unblock) the server thread associated to chdev,
219 * and blocks itself on the THREAD_BLOCKED_IO condition.
220 ******************************************************************************************
221 * @ chdev_xp  : extended pointer on remote chdev descriptor.
222 *****************************************************************************************/
223void chdev_register_command( xptr_t chdev_xp );
224
225/******************************************************************************************
226 * This function is executed by the server thread associated to a chdev descriptor.
227 * It executes an infinite loop to handle sequencially all commands registered by the
228 * client threads in the device waiting queue, until the queue is empty.
229 * The driver CMD function being blocking, these functions return only when the command
230 * is completed. These functions can use either a busy waiting policy, or a descheduling
231 * policy, blocking on the THREAD_BLOCKED_IO_ISR condition, and reactivated by the ISR.
232 * When the waiting queue is empty, the server thread blocks on the THREAD_BLOCKED_IO_CMD
233 * condition and deschedule. It is re-activated by a client thread registering a command.
234 ******************************************************************************************
235 * @ chdev   : local pointer on device descriptor.
236 *****************************************************************************************/
237void chdev_sequencial_server( chdev_t * chdev );
238
239/******************************************************************************************
240 * This function returns an extended pointer on the chdev associated to a pseudo file
241 * descriptor (type INODE_TYPE_DEV) identified by the <file_xp> argument.
242 * It can be called by a thread running in any cluster.
243 * It enters kernel panic if the inode has not the expected type.
244 ******************************************************************************************
245 * @ file_xp   : extended pointer on the pseudo file descriptor.
246 * @ return an extended pointer on chdev.
247 *****************************************************************************************/
248xptr_t chdev_from_file( xptr_t file_xp );
249
250/******************************************************************************************
251 * This function displays the local copy of the external chdevs directory.
252 * (global variable replicated in all clusters)
253 *****************************************************************************************/
254void chdev_dir_display( void );
255
256/******************************************************************************************
257 * This function displays the list of threads registered in the queue associated
258 * to the chdev identified by the <chdev_xp>.
259 ******************************************************************************************
260 * # root_xp  : extended pointer
261 *****************************************************************************************/
262void chdev_queue_display( xptr_t chdev_xp );
263
264#endif  /* _CHDEV_H_ */
Note: See TracBrowser for help on using the repository browser.