source: trunk/hal/tsar_mips32/drivers/soclib_bdv.c @ 626

Last change on this file since 626 was 626, checked in by alain, 3 years ago

This version has been tested on the sort multithreaded application
for TSAR_IOB architectures ranging from 1 to 8 clusters.
It fixes three bigs bugs:
1) the dev_ioc device API has been modified: the dev_ioc_sync_read()
and dev_ioc_sync_write() function use now extended pointers on the
kernel buffer to access a mapper stored in any cluster.
2) the hal_uspace API has been modified: the hal_copy_to_uspace()
and hal_copy_from_uspace() functions use now a (cxy,ptr) couple
to identify the target buffer (equivalent to an extended pointer.
3) an implementation bug has been fixed in the assembly code contained
in the hal_copy_to_uspace() and hal_copy_from_uspace() functions.

File size: 11.2 KB
Line 
1/*
2 * soclib_bdv.c - soclib simple block device driver implementation.
3 *
4 * Author     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#include <soclib_bdv.h>
25#include <hal_kernel_types.h>
26#include <chdev.h>
27#include <dev_ioc.h>
28#include <printk.h>
29#include <thread.h>
30#include <hal_irqmask.h>
31
32///////////////////////////////////////
33void soclib_bdv_init( chdev_t * chdev )
34{
35    // get extended pointer on SOCLIB_BDV peripheral base
36        xptr_t  bdv_xp = chdev->base;
37
38    // set driver specific fields
39    chdev->cmd = &soclib_bdv_cmd;
40    chdev->isr = &soclib_bdv_isr;
41
42    // get hardware device cluster and local pointer
43    cxy_t      bdv_cxy  = GET_CXY( bdv_xp );
44    uint32_t * bdv_ptr  = (uint32_t *)GET_PTR( bdv_xp );
45
46    // get block_size and block_count 
47        uint32_t block_size = hal_remote_l32( XPTR( bdv_cxy , bdv_ptr + BDV_BLOCK_SIZE_REG ) );
48        uint32_t block_count = hal_remote_l32( XPTR( bdv_cxy , bdv_ptr + BDV_SIZE_REG ) );
49
50    // set IOC device descriptor extension
51    chdev->ext.ioc.size  = block_size;
52    chdev->ext.ioc.count = block_count;
53
54} // end soclib_bdv_init()
55
56
57//////////////////////////////////////////////////////////////
58void __attribute__ ((noinline)) soclib_bdv_cmd( xptr_t th_xp )
59{
60    uint32_t   cmd_type;    // IOC_READ / IOC_WRITE / IOC_SYNC_READ / IOC_SYNC_WRITE
61    uint32_t   lba;
62    uint32_t   count;
63    xptr_t     buf_xp;
64    xptr_t     ioc_xp;
65    uint32_t   status;      // I/0 operation status (from BDV)
66    reg_t      save_sr;     // for critical section
67    uint32_t   op;          // BDV_OP_READ / BDV_OP_WRITE
68
69    // get client thread cluster and local pointer
70    cxy_t      th_cxy = GET_CXY( th_xp );
71    thread_t * th_ptr = GET_PTR( th_xp );
72
73#if (DEBUG_HAL_IOC_RX || DEBUG_HAL_IOC_TX)
74uint32_t    cycle        = (uint32_t)hal_get_cycles();
75thread_t  * this         = CURRENT_THREAD;
76process_t * process      = hal_remote_lpt( XPTR( th_cxy , &th_ptr->process ) );
77pid_t       client_pid   = hal_remote_l32( XPTR( th_cxy , &process->pid ) );
78trdid_t     client_trdid = hal_remote_l32( XPTR( th_cxy , &th_ptr->trdid ) );
79#endif
80
81    // get command arguments and extended pointer on IOC device
82    cmd_type =         hal_remote_l32( XPTR( th_cxy , &th_ptr->ioc_cmd.type   ) );
83    lba      =         hal_remote_l32( XPTR( th_cxy , &th_ptr->ioc_cmd.lba    ) );
84    count    =         hal_remote_l32( XPTR( th_cxy , &th_ptr->ioc_cmd.count  ) );
85    buf_xp   = (xptr_t)hal_remote_l64( XPTR( th_cxy , &th_ptr->ioc_cmd.buf_xp ) );
86    ioc_xp   = (xptr_t)hal_remote_l64( XPTR( th_cxy , &th_ptr->ioc_cmd.dev_xp ) );
87
88    // decode command
89    if     ( (cmd_type == IOC_READ)  || (cmd_type == IOC_SYNC_READ)  ) op = BDV_OP_READ;
90    else if( (cmd_type == IOC_WRITE) || (cmd_type == IOC_SYNC_WRITE) ) op = BDV_OP_WRITE;
91    else     assert( false , "illegal command" );
92
93    // get IOC device cluster and local pointer
94    cxy_t      ioc_cxy = GET_CXY( ioc_xp );
95    chdev_t  * ioc_ptr = GET_PTR( ioc_xp );
96
97    // get cluster and pointers for SOCLIB-BDV peripheral segment base
98    xptr_t     seg_xp  = (xptr_t)hal_remote_l64( XPTR( ioc_cxy , &ioc_ptr->base ) );
99    cxy_t      seg_cxy = GET_CXY( seg_xp );
100    uint32_t * seg_ptr = GET_PTR( seg_xp );
101
102    // split buffer address in two 32 bits words
103    uint32_t   buf_lsb = (uint32_t)(buf_xp);
104    uint32_t   buf_msb = (uint32_t)(buf_xp>>32);
105
106#if DEBUG_HAL_IOC_RX
107if( DEBUG_HAL_IOC_RX < cycle )
108printk("\n[%s] thread[%x,%x] enters / client[%x,%x] / cmd %d / lba %x / buf(%x,%x) / cycle %d\n",
109__FUNCTION__ , this->process->pid, this->trdid, client_pid, client_trdid,
110cmd_type, lba, buf_msb, buf_lsb, cycle );
111#endif
112
113#if DEBUG_HAL_IOC_TX
114if( DEBUG_HAL_IOC_TX < cycle )
115printk("\n[%s] thread[%x,%x] enters / client[%x,%x] / cmd %d / lba %x / buf(%x,%x) / cycle %d\n",
116__FUNCTION__ , this->process->pid, this->trdid, client_pid, client_trdid,
117cmd_type, lba, buf_msb, buf_lsb, cycle );
118#endif
119
120    // select operation
121    if( (cmd_type == IOC_READ) || (cmd_type == IOC_SYNC_READ) ) op = BDV_OP_READ; 
122    else                                                        op = BDV_OP_WRITE;
123
124    // set SOCLIB_BDV registers to configure the I/O operation
125    hal_remote_s32( XPTR( seg_cxy , seg_ptr + BDV_IRQ_ENABLE_REG ) , 1       );
126    hal_remote_s32( XPTR( seg_cxy , seg_ptr + BDV_BUFFER_REG     ) , buf_lsb ); 
127    hal_remote_s32( XPTR( seg_cxy , seg_ptr + BDV_BUFFER_EXT_REG ) , buf_msb ); 
128    hal_remote_s32( XPTR( seg_cxy , seg_ptr + BDV_LBA_REG        ) , lba     );
129    hal_remote_s32( XPTR( seg_cxy , seg_ptr + BDV_COUNT_REG      ) , count   );
130
131    // waiting policy  depends on the command type
132    // - for IOC_READ / IOC_WRITE commands, this function is called by the server thread
133    //   that blocks and deschedules after launching the I/O transfer.
134    //   The I/O operation status is reported in the command by the ISR.
135    // - for IOC_SYNC_READ / IOC_SYNC_WRITE command, this function is called by the client
136    //   thread that polls the BDV status register until I/O transfer completion.
137
138    if( (cmd_type == IOC_SYNC_READ) || (cmd_type == IOC_SYNC_WRITE) )  // polling policy
139    {
140        // launch I/O operation on BDV device
141        hal_remote_s32( XPTR( seg_cxy , seg_ptr + BDV_OP_REG ) , op );
142       
143        // wait completion
144        while (1)
145        {
146            status = hal_remote_l32( XPTR( seg_cxy , seg_ptr + BDV_STATUS_REG ) );
147
148            if( (status == BDV_READ_SUCCESS) ||
149                (status == BDV_WRITE_SUCCESS) ) // successfully completed
150            {
151                hal_remote_s32( XPTR( th_cxy , &th_ptr->ioc_cmd.error ) , 0 );
152
153#if DEBUG_HAL_IOC_RX
154cycle = (uint32_t)hal_get_cycles();
155if( (DEBUG_HAL_IOC_RX < cycle) && (cmd_type == IOC_SYNC_READ) )
156printk("\n[%s] thread[%x,%x] exit after SYNC_READ for client thread[%x,%x] / cycle %d\n",
157__FUNCTION__, this->process->pid, this->trdid, client_pid, client_trdid, cycle );
158#endif
159
160#if DEBUG_HAL_IOC_TX
161cycle = (uint32_t)hal_get_cycles();
162if( (DEBUG_HAL_IOC_TX < cycle) && (cmd_type == IOC_SYNC_WRITE) )
163printk("\n[%s] thread[%x,%x] exit after SYNC_WRITE for client thread[%x,%x] / cycle %d\n",
164__FUNCTION__, this->process->pid, this->trdid, client_pid, client_trdid, cycle );
165#endif
166                break;
167            }
168            else if( status == BDV_BUSY )      // non completed
169            {
170                continue;
171            }
172            else                               // error reported
173            {
174                hal_remote_s32( XPTR( th_cxy , &th_ptr->ioc_cmd.error ) , 1 );
175                break;
176            }
177        }
178    }
179    else                                                     // descheduling + IRQ policy
180    { 
181        // enter critical section to atomically
182        // lauch I/O operation and deschedule 
183        hal_disable_irq( &save_sr );
184
185        // launch I/O operation on BDV device
186        hal_remote_s32( XPTR( seg_cxy , seg_ptr + BDV_OP_REG ) , op );
187       
188        // server thread blocks on ISR
189        thread_block( XPTR( local_cxy , CURRENT_THREAD ) , THREAD_BLOCKED_ISR );
190
191#if DEBUG_HAL_IOC_RX
192if( (DEBUG_HAL_IOC_RX < cycle) && (cmd_type != IOC_WRITE ) )
193printk("\n[%s] thread[%x,%x] blocks & deschedules after lauching READ transfer\n",
194__FUNCTION__ , this->process->pid, this->trdid );
195#endif
196
197#if DEBUG_HAL_IOC_TX
198if( (DEBUG_HAL_IOC_TX < cycle) && (cmd_type == IOC_WRITE) )
199printk("\n[%s] thread[%x,%x] blocks & deschedules after lauching WRITE transfer\n",
200__FUNCTION__ , this->process->pid, this->trdid );
201#endif
202        // server thread deschedules
203        sched_yield("blocked on ISR");
204
205        // exit critical section
206        hal_restore_irq( save_sr );
207   
208#if DEBUG_HAL_IOC_RX
209cycle = (uint32_t)hal_get_cycles();
210if( (DEBUG_HAL_IOC_RX < cycle) && (cmd_type != IOC_WRITE) )
211printk("\n[%s] thread[%x,%x] exit after READ for client thread[%x,%x] / cycle %d\n",
212__FUNCTION__, this->process->pid, this->trdid, client_pid, client_trdid, cycle );
213#endif
214
215#if DEBUG_HAL_IOC_TX
216cycle = (uint32_t)hal_get_cycles();
217if( (DEBUG_HAL_IOC_TX < cycle) && (cmd_type == IOC_WRITE) )
218printk("\n[%s] thread[%x,%x] exit after WRITE for client thread[%x,%x] / cycle %d\n",
219__FUNCTION__, this->process->pid, this->trdid, client_pid, client_trdid, cycle );
220#endif
221
222    }
223
224} // end soclib_bdv_cmd()
225
226
227/////////////////////////////////////////////////////////////////
228void __attribute__ ((noinline)) soclib_bdv_isr( chdev_t * chdev )
229{
230    error_t  error = 0;
231
232    // get extended pointer on server thread
233    xptr_t server_xp = XPTR( local_cxy , chdev->server );
234
235    // get extended pointer on client thread
236    xptr_t root      = XPTR( local_cxy , &chdev->wait_root );
237    xptr_t client_xp = XLIST_FIRST( root , thread_t , wait_list );
238
239    // get client thread cluster and local pointer
240    cxy_t      client_cxy = GET_CXY( client_xp );
241    thread_t * client_ptr = GET_PTR( client_xp );
242
243    // get command type
244    uint32_t   cmd_type = hal_remote_l32( XPTR( client_cxy , &client_ptr->ioc_cmd.type ) );
245   
246#if (DEBUG_HAL_IOC_RX || DEBUG_HAL_IOC_TX)
247uint32_t    cycle        = (uint32_t)hal_get_cycles();
248process_t * process      = hal_remote_lpt( XPTR( client_cxy , &client_ptr->process ) );
249pid_t       client_pid   = hal_remote_l32( XPTR( client_cxy , &process->pid ) );
250trdid_t     client_trdid = hal_remote_l32( XPTR( client_cxy , &client_ptr->trdid ) );
251thread_t  * server       = GET_PTR( server_xp );
252pid_t       server_pid   = server->process->pid;
253trdid_t     server_trdid = server->trdid;
254#endif
255
256    // get SOCLIB_BDV device cluster and local pointer
257    cxy_t      bdv_cxy  = GET_CXY( chdev->base );
258    uint32_t * bdv_ptr  = GET_PTR( chdev->base );
259
260    // get BDV status register and acknowledge IRQ
261        uint32_t status = hal_remote_l32( XPTR( bdv_cxy , bdv_ptr + BDV_STATUS_REG ) );   
262
263    if( cmd_type == IOC_READ )
264    {
265            error = (status != BDV_READ_SUCCESS);
266
267#if DEBUG_HAL_IOC_RX
268if( DEBUG_HAL_IOC_RX < cycle )
269printk("\n[%s] RX transfer completed for client[%x,%x] / server[%x,%x] / cycle %d\n",
270__FUNCTION__, client_pid, client_trdid, server_pid, server_trdid, cycle );
271#endif
272
273    }
274        else if( cmd_type == IOC_WRITE )
275    {
276            error = (status != BDV_WRITE_SUCCESS);
277
278#if DEBUG_HAL_IOC_TX
279if( DEBUG_HAL_IOC_TX < cycle )
280printk("\n[%s] TX transfer completed for client[%x,%x] / server[%x,%x] / cycle %d\n",
281__FUNCTION__, client_pid, client_trdid, server_pid, server_trdid, cycle );
282#endif
283
284    }
285    else
286    {
287        assert( false , "illegal command %d", cmd_type );
288    } 
289
290    // set operation status in command
291    hal_remote_s32( XPTR( client_cxy , &client_ptr->ioc_cmd.error ) , error );
292
293    // unblock server thread
294    thread_unblock( server_xp , THREAD_BLOCKED_ISR );
295
296} // end soclib_bdv_isr()
297
298
299
Note: See TracBrowser for help on using the repository browser.