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

Last change on this file since 684 was 679, checked in by alain, 4 years ago

Mainly cosmetic.
File size: 12.5 KB
Line 
1/*
2 * soclib_bdv.c - soclib simple block device driver implementation.
3 *
4 * Author     Alain Greiner (2016,2017,2018,2019,2020)
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    // set driver specific fields in IOC chdev
36    chdev->cmd = &soclib_bdv_cmd;
37    chdev->isr = &soclib_bdv_isr;
38
39    // get extended pointer on SOCLIB_BDV peripheral base
40        xptr_t  base_xp = chdev->base;
41
42    // get hardware device cluster and local pointer
43    cxy_t      base_cxy  = GET_CXY( base_xp );
44    uint32_t * base_ptr  = GET_PTR( base_xp );
45
46    // get block_size and block_count 
47        uint32_t block_size  = hal_remote_l32( XPTR( base_cxy , base_ptr + BDV_BLOCK_SIZE_REG ) );
48        uint32_t block_count = hal_remote_l32( XPTR( base_cxy , base_ptr + BDV_SIZE_REG ) );
49
50    // set IOC chdev extension fields
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( __FUNCTION__, false , "illegal command" );
92
93    // get cluster and local pointer on IOC chdev
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    //   => block and deschedule after launching the I/O transfer.
134    //   The I/O operation status is reported in the command by the ISR, and the
135    //   server thread is re-activated by the ISR.
136    // - for IOC_SYNC_READ / IOC_SYNC_WRITE, this function is called by the client thread
137    //   => mask the IOC IRQ and poll the BDV status register until I/O transfer completion,
138    //   and report status in the command.
139
140    if( (cmd_type == IOC_SYNC_READ) || (cmd_type == IOC_SYNC_WRITE) )  // polling policy
141    {
142        // get core handling the IOC IRQ
143        thread_t * server = (thread_t *)hal_remote_lpt( XPTR( ioc_cxy , &ioc_ptr->server ) );
144        core_t   * core   = (core_t *)hal_remote_lpt( XPTR( ioc_cxy , &server->core ) );
145        lid_t      lid    = (lid_t)hal_remote_l32( XPTR( ioc_cxy , &core->lid ) );
146
147        // mask the IOC IRQ
148        dev_pic_disable_irq( lid , ioc_xp );
149
150        // launch I/O operation on BDV device
151        hal_remote_s32( XPTR( seg_cxy , seg_ptr + BDV_OP_REG ) , op );
152       
153        // wait completion
154        while (1)
155        {
156            status = hal_remote_l32( XPTR( seg_cxy , seg_ptr + BDV_STATUS_REG ) );
157
158            if( (status == BDV_READ_SUCCESS) ||
159                (status == BDV_WRITE_SUCCESS) ) // successfully completed
160            {
161                // unmask IOC IRQ
162                dev_pic_enable_irq( lid , ioc_xp );
163
164                // report success in command
165                hal_remote_s32( XPTR( th_cxy , &th_ptr->ioc_cmd.error ) , 0 );
166
167#if DEBUG_HAL_IOC_RX
168cycle = (uint32_t)hal_get_cycles();
169if( (DEBUG_HAL_IOC_RX < cycle) && (cmd_type == IOC_SYNC_READ) )
170printk("\n[%s] thread[%x,%x] SYNC_READ success for client thread[%x,%x] / cycle %d\n",
171__FUNCTION__, this->process->pid, this->trdid, client_pid, client_trdid, cycle );
172#endif
173
174#if DEBUG_HAL_IOC_TX
175cycle = (uint32_t)hal_get_cycles();
176if( (DEBUG_HAL_IOC_TX < cycle) && (cmd_type == IOC_SYNC_WRITE) )
177printk("\n[%s] thread[%x,%x] SYNC_WRITE success for client thread[%x,%x] / cycle %d\n",
178__FUNCTION__, this->process->pid, this->trdid, client_pid, client_trdid, cycle );
179#endif
180                break;
181            }
182            else if( status == BDV_BUSY )      // non completed
183            {
184                continue;
185            }
186            else                               // error reported
187            {
188                // unmask IOC IRQ
189                dev_pic_enable_irq( lid , ioc_xp );
190
191                // report failure in command
192                hal_remote_s32( XPTR( th_cxy , &th_ptr->ioc_cmd.error ) , 1 );
193
194#if DEBUG_HAL_IOC_RX
195cycle = (uint32_t)hal_get_cycles();
196if( (DEBUG_HAL_IOC_RX < cycle) && (cmd_type == IOC_SYNC_READ) )
197printk("\n[%s] thread[%x,%x] SYNC_READ failure for client thread[%x,%x] / cycle %d\n",
198__FUNCTION__, this->process->pid, this->trdid, client_pid, client_trdid, cycle );
199#endif
200
201#if DEBUG_HAL_IOC_TX
202cycle = (uint32_t)hal_get_cycles();
203if( (DEBUG_HAL_IOC_TX < cycle) && (cmd_type == IOC_SYNC_WRITE) )
204printk("\n[%s] thread[%x,%x] SYNC_WRITE failure for client thread[%x,%x] / cycle %d\n",
205__FUNCTION__, this->process->pid, this->trdid, client_pid, client_trdid, cycle );
206#endif
207                break;
208            }
209        }
210    }
211    else                                                     // descheduling + IRQ policy
212    { 
213        // enter critical section to atomically
214        // lauch I/O operation and deschedule 
215        hal_disable_irq( &save_sr );
216
217        // launch I/O operation on BDV device
218        hal_remote_s32( XPTR( seg_cxy , seg_ptr + BDV_OP_REG ) , op );
219       
220        // server thread blocks on ISR
221        thread_block( XPTR( local_cxy , CURRENT_THREAD ) , THREAD_BLOCKED_ISR );
222
223#if DEBUG_HAL_IOC_RX
224if( (DEBUG_HAL_IOC_RX < cycle) && (cmd_type != IOC_WRITE ) )
225printk("\n[%s] thread[%x,%x] blocks & deschedules after lauching READ transfer\n",
226__FUNCTION__ , this->process->pid, this->trdid );
227#endif
228
229#if DEBUG_HAL_IOC_TX
230if( (DEBUG_HAL_IOC_TX < cycle) && (cmd_type == IOC_WRITE) )
231printk("\n[%s] thread[%x,%x] blocks & deschedules after lauching WRITE transfer\n",
232__FUNCTION__ , this->process->pid, this->trdid );
233#endif
234        // server thread deschedules
235        sched_yield("blocked on ISR");
236
237        // exit critical section
238        hal_restore_irq( save_sr );
239   
240#if DEBUG_HAL_IOC_RX
241cycle = (uint32_t)hal_get_cycles();
242if( (DEBUG_HAL_IOC_RX < cycle) && (cmd_type != IOC_WRITE) )
243printk("\n[%s] thread[%x,%x] exit after READ for client thread[%x,%x] / cycle %d\n",
244__FUNCTION__, this->process->pid, this->trdid, client_pid, client_trdid, cycle );
245#endif
246
247#if DEBUG_HAL_IOC_TX
248cycle = (uint32_t)hal_get_cycles();
249if( (DEBUG_HAL_IOC_TX < cycle) && (cmd_type == IOC_WRITE) )
250printk("\n[%s] thread[%x,%x] exit after WRITE for client thread[%x,%x] / cycle %d\n",
251__FUNCTION__, this->process->pid, this->trdid, client_pid, client_trdid, cycle );
252#endif
253
254    }
255
256} // end soclib_bdv_cmd()
257
258
259/////////////////////////////////////////////////////////////////
260void __attribute__ ((noinline)) soclib_bdv_isr( chdev_t * chdev )
261{
262    error_t  error = 0;
263
264    // get extended pointer on server thread
265    xptr_t server_xp = XPTR( local_cxy , chdev->server );
266
267    // get extended pointer on client thread
268    xptr_t root      = XPTR( local_cxy , &chdev->wait_root );
269    xptr_t client_xp = XLIST_FIRST( root , thread_t , wait_list );
270
271    // get client thread cluster and local pointer
272    cxy_t      client_cxy = GET_CXY( client_xp );
273    thread_t * client_ptr = GET_PTR( client_xp );
274
275    // get command type
276    uint32_t   cmd_type = hal_remote_l32( XPTR( client_cxy , &client_ptr->ioc_cmd.type ) );
277   
278#if (DEBUG_HAL_IOC_RX || DEBUG_HAL_IOC_TX)
279uint32_t    cycle        = (uint32_t)hal_get_cycles();
280process_t * process      = hal_remote_lpt( XPTR( client_cxy , &client_ptr->process ) );
281pid_t       client_pid   = hal_remote_l32( XPTR( client_cxy , &process->pid ) );
282trdid_t     client_trdid = hal_remote_l32( XPTR( client_cxy , &client_ptr->trdid ) );
283thread_t  * server       = GET_PTR( server_xp );
284pid_t       server_pid   = server->process->pid;
285trdid_t     server_trdid = server->trdid;
286#endif
287
288    // get SOCLIB_BDV device cluster and local pointer
289    cxy_t      bdv_cxy  = GET_CXY( chdev->base );
290    uint32_t * bdv_ptr  = GET_PTR( chdev->base );
291
292    // get BDV status register and acknowledge IRQ
293        uint32_t status = hal_remote_l32( XPTR( bdv_cxy , bdv_ptr + BDV_STATUS_REG ) );   
294
295    if( cmd_type == IOC_READ )
296    {
297            error = (status != BDV_READ_SUCCESS);
298
299#if DEBUG_HAL_IOC_RX
300if( DEBUG_HAL_IOC_RX < cycle )
301printk("\n[%s] RX transfer completed for client[%x,%x] / server[%x,%x] / cycle %d\n",
302__FUNCTION__, client_pid, client_trdid, server_pid, server_trdid, cycle );
303#endif
304
305    }
306        else if( cmd_type == IOC_WRITE )
307    {
308            error = (status != BDV_WRITE_SUCCESS);
309
310#if DEBUG_HAL_IOC_TX
311if( DEBUG_HAL_IOC_TX < cycle )
312printk("\n[%s] TX transfer completed for client[%x,%x] / server[%x,%x] / cycle %d\n",
313__FUNCTION__, client_pid, client_trdid, server_pid, server_trdid, cycle );
314#endif
315
316    }
317    else
318    {
319        assert( __FUNCTION__, false , "illegal command %d", cmd_type );
320    } 
321
322    // set operation status in command
323    hal_remote_s32( XPTR( client_cxy , &client_ptr->ioc_cmd.error ) , error );
324
325    // unblock server thread
326    thread_unblock( server_xp , THREAD_BLOCKED_ISR );
327
328} // end soclib_bdv_isr()
329
330
331
Note: See TracBrowser for help on using the repository browser.