source: trunk/kernel/devices/dev_ioc.c @ 492

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

Refactoring assert calling to conform with new assert macro.

Made with this command for the general case.
find ./kernel/ hal/ -name "*.c" | xargs sed -i -e '/assert(/ s/,[ ]*FUNCTION[ ]*,/,/'

And some done by hand.

File size: 7.9 KB
Line 
1/*
2 * dev_ioc.c - IOC (Block Device Controler) generic device API implementation.
3 *
4 * Author  Alain Greiner    (2016,2017,2018)
5 *
6 * Copyright (c) UPMC Sorbonne Universites
7 *
8 * This file is part of ALMOS-MK
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#include <kernel_config.h>
25#include <hal_kernel_types.h>
26#include <hal_gpt.h>
27#include <hal_drivers.h>
28#include <thread.h>
29#include <printk.h>
30#include <chdev.h>
31#include <dev_ioc.h>
32
33/////////////////////////////////////////////////////////////////////////////////////////
34// Extern global variables
35/////////////////////////////////////////////////////////////////////////////////////////
36
37extern chdev_directory_t  chdev_dir;     // allocated in kernel_init.c
38
39//////////////////////////////////
40void dev_ioc_init( chdev_t * ioc )
41{
42    // the PIC chdev must be initialized before the IOC chdev, because
43    // the IOC chdev initialisation requires the routing of an external IRQ
44    xptr_t  pic_xp  = chdev_dir.pic;
45
46    assert( (pic_xp != XPTR_NULL) , "PIC not initialised before IOC" );
47
48    // get implementation and channel from chdev descriptor
49    uint32_t  impl    = ioc->impl;
50    uint32_t  channel = ioc->channel;
51
52    // set chdev name
53    snprintf( ioc->name , 16 , "ioc%d" , channel );
54
55    // call driver init function
56    hal_drivers_ioc_init( ioc, impl );
57
58    // select a core to execute the IOC server thread
59    lid_t lid = cluster_select_local_core();
60
61    // bind the IOC IRQ to the selected core
62    dev_pic_bind_irq( lid , ioc );
63
64    // enable IRQ
65    dev_pic_enable_irq( lid , XPTR( local_cxy , ioc ) );
66
67    // create server thread
68    thread_t * new_thread;
69    error_t    error;
70
71    error = thread_kernel_create( &new_thread,
72                                  THREAD_DEV,
73                                  &chdev_sequencial_server,
74                                  ioc,
75                                  lid );
76
77    assert( (error == 0) , "cannot create server thread" );
78
79    // set "server" field in chdev descriptor
80    ioc->server = new_thread;
81
82    // set "chdev field in thread descriptor
83    new_thread->chdev = ioc;
84
85    // unblock server thread
86    thread_unblock( XPTR( local_cxy , new_thread ) , THREAD_BLOCKED_GLOBAL );
87
88}  // end dev_ioc_init()
89
90//////////////////////////////////////////////////////////////////////////////////
91// This static function is called by dev_ioc_read() & dev_ioc_write() functions.
92// It builds and registers the command in the calling thread descriptor.
93// Then, it registers the calling thead in IOCchdev waiting queue.
94// Finally it blocks on the THREAD_BLOCKED_IO condition and deschedule.
95////////////////////////////////////i/////////////////////////////////////////////
96static error_t dev_ioc_access( uint32_t   cmd_type,
97                               uint8_t  * buffer,
98                               uint32_t   lba,
99                               uint32_t   count )
100{
101    thread_t * this = CURRENT_THREAD;              // pointer on client thread
102
103    // software L2/L3 cache coherence for memory buffer
104    if( chdev_dir.iob )
105    {
106        if ( cmd_type == IOC_READ ) dev_mmc_inval( XPTR( local_cxy , buffer ) , count<<9 );
107        else                        dev_mmc_sync ( XPTR( local_cxy , buffer ) , count<<9 );
108    }
109
110    // get extended pointer on IOC chdev descriptor
111    xptr_t  dev_xp = chdev_dir.ioc[0];
112
113    assert( (dev_xp != XPTR_NULL) , "undefined IOC chdev descriptor" );
114
115    // register command in calling thread descriptor
116    this->ioc_cmd.dev_xp    = dev_xp;
117    this->ioc_cmd.type      = cmd_type;
118    this->ioc_cmd.buf_xp    = XPTR( local_cxy , buffer );
119    this->ioc_cmd.lba       = lba;
120    this->ioc_cmd.count     = count;
121
122    // register client thread in IOC chdev waiting queue, activate server thread,
123    // block client thread on THREAD_BLOCKED_IO and deschedule.
124    // it is re-activated by the ISR signaling IO operation completion.
125    chdev_register_command( dev_xp );
126
127    // return I/O operation status
128    return this->ioc_cmd.error;
129
130}  // end dev_ioc_access()
131
132////////////////////////////////////////////
133error_t dev_ioc_read( uint8_t      * buffer,
134                      uint32_t       lba,
135                      uint32_t       count )
136{
137
138#if DEBUG_DEV_IOC_RX
139uint32_t cycle = (uint32_t)hal_get_cycles();
140if( DEBUG_DEV_IOC_RX < cycle )
141printk("\n[DBG] %s : thread %x enters / lba  %x / buffer %x / cycle %d\n",
142__FUNCTION__ , this, lba, buffer, cycle );
143#endif
144
145    return dev_ioc_access( IOC_READ , buffer , lba , count );
146
147#if DEBUG_DEV_IOC_RX
148cycle = (uint32_t)hal_get_cycles();
149if( DEBUG_DEV_IOC_RX < cycle )
150printk("\n[DBG] %s : thread %x exit / lba  %x / buffer %x / cycle %d\n",
151__FUNCTION__ , this, lba, buffer, cycle );
152#endif
153
154}
155
156////////////////////////////////////////////
157error_t dev_ioc_write( uint8_t     * buffer,
158                       uint32_t      lba,
159                       uint32_t      count )
160{
161
162#if DEBUG_DEV_IOC_TX
163uint32_t cycle = (uint32_t)hal_get_cycles();
164if( DEBUG_DEV_IOC_TX < cycle )
165printk("\n[DBG] %s : thread %x enters / lba  %x / buffer %x / cycle %d\n",
166__FUNCTION__ , this, lba, buffer, cycle );
167#endif
168
169    return dev_ioc_access( IOC_WRITE , buffer , lba , count );
170
171#if DEBUG_DEV_IOC_TX
172cycle = (uint32_t)hal_get_cycles();
173if( DEBUG_DEV_IOC_TX < cycle )
174printk("\n[DBG] %s : thread %x exit / lba  %x / buffer %x / cycle %d\n",
175__FUNCTION__ , this, lba, buffer, cycle );
176#endif
177
178}
179
180/////////////////////////////////////////////
181error_t dev_ioc_sync_read( uint8_t  * buffer,
182                           uint32_t   lba,
183                           uint32_t   count )
184{
185    // get pointer on calling thread
186    thread_t * this = CURRENT_THREAD;
187
188#if DEBUG_DEV_IOC_RX
189uint32_t cycle = (uint32_t)hal_get_cycles();
190if( DEBUG_DEV_IOC_RX < cycle )
191printk("\n[DBG] %s : thread %x enters / lba  %x / buffer %x / cycle %d\n",
192__FUNCTION__ , this, lba, buffer, cycle );
193#endif
194
195    // software L2/L3 cache coherence for memory buffer
196    if( chdev_dir.iob ) dev_mmc_inval( XPTR( local_cxy , buffer ) , count<<9 );
197
198    // get extended pointer on IOC[0] chdev
199    xptr_t  ioc_xp = chdev_dir.ioc[0];
200
201    assert( (ioc_xp != XPTR_NULL) , "undefined IOC chdev descriptor" );
202
203    // register command in calling thread descriptor
204    this->ioc_cmd.dev_xp    = ioc_xp;
205    this->ioc_cmd.type      = IOC_SYNC_READ;
206    this->ioc_cmd.buf_xp    = XPTR( local_cxy , buffer );
207    this->ioc_cmd.lba       = lba;
208    this->ioc_cmd.count     = count;
209
210    // get driver command function
211    cxy_t       ioc_cxy = GET_CXY( ioc_xp );
212    chdev_t   * ioc_ptr = (chdev_t *)GET_PTR( ioc_xp );
213    dev_cmd_t * cmd = (dev_cmd_t *)hal_remote_lpt( XPTR( ioc_cxy , &ioc_ptr->cmd ) );
214
215    // get core local index for the core handling the IOC IRQ
216    thread_t * server = (thread_t *)hal_remote_lpt( XPTR( ioc_cxy , &ioc_ptr->server ) );
217    core_t   * core   = (core_t *)hal_remote_lpt( XPTR( ioc_cxy , &server->core ) );
218    lid_t      lid    = (lid_t)hal_remote_lw( XPTR( ioc_cxy , &core->lid ) );
219
220    // mask the IRQ
221    dev_pic_disable_irq( lid , ioc_xp );
222
223    // call driver function
224    cmd( XPTR( local_cxy , this ) );
225
226    // unmask the IRQ
227    dev_pic_enable_irq( lid , ioc_xp );
228
229#if DEBUG_DEV_IOC_RX
230cycle = (uint32_t)hal_get_cycles();
231if( DEBUG_DEV_IOC_RX < cycle )
232printk("\n[DBG] %s : thread %x exit / lba  %x / buffer %x / cycle %d\n",
233__FUNCTION__ , this, lba, buffer, cycle );
234#endif
235
236    // return I/O operation status from calling thread descriptor
237    return this->ioc_cmd.error;
238
239}  // end ioc_sync_read()
240
Note: See TracBrowser for help on using the repository browser.