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

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

Fix a bug in scheduler related to RPC blocking.

File size: 8.0 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 <chdev.h>
25#include <dev_ioc.h>
26#include <soclib_bdv.h>
27#include <printk.h>
28#include <thread.h>
29#include <spinlock.h>
30
31
32///////////////////////////////////////
33void soclib_bdv_init( chdev_t * chdev )
34{
35    // get extended pointer on SOCLIB_BDV peripheral base address
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_lw( XPTR( bdv_cxy , bdv_ptr + BDV_BLOCK_SIZE_REG ) );
48        uint32_t block_count = hal_remote_lw( 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
61    uint32_t   lba;
62    uint32_t   count;
63    xptr_t     buf_xp;
64    xptr_t     ioc_xp;
65
66    // get client thread cluster and local pointer
67    cxy_t      th_cxy = GET_CXY( th_xp );
68    thread_t * th_ptr = (thread_t *)GET_PTR( th_xp );
69
70    // get command arguments and extended pointer on IOC device
71    cmd_type =         hal_remote_lw ( XPTR( th_cxy , &th_ptr->ioc_cmd.type   ) );
72    lba      =         hal_remote_lw ( XPTR( th_cxy , &th_ptr->ioc_cmd.lba    ) );
73    count    =         hal_remote_lw ( XPTR( th_cxy , &th_ptr->ioc_cmd.count  ) );
74    buf_xp   = (xptr_t)hal_remote_lwd( XPTR( th_cxy , &th_ptr->ioc_cmd.buf_xp ) );
75    ioc_xp   = (xptr_t)hal_remote_lwd( XPTR( th_cxy , &th_ptr->ioc_cmd.dev_xp ) );
76
77#if DEBUG_HAL_IOC_RX
78uint32_t cycle = (uint32_t)hal_get_cycles();
79if( (DEBUG_HAL_IOC_RX < cycle) && (cmd_type != IOC_WRITE ) )
80printk("\n[DBG] %s : thread %x enter for RX / cycle %d\n",
81__FUNCTION__ , CURRENT_THREAD , cycle );
82#endif
83
84#if DEBUG_HAL_IOC_TX
85uint32_t cycle = (uint32_t)hal_get_cycles();
86if( (DEBUG_HAL_IOC_TX < cycle) && (cmd_type == IOC_WRITE) )
87printk("\n[DBG] %s : thread %x enter for TX / cycle %d\n",
88__FUNCTION__ , CURRENT_THREAD , cycle );
89#endif
90
91    // get IOC device cluster and local pointer
92    cxy_t      ioc_cxy = GET_CXY( ioc_xp );
93    chdev_t  * ioc_ptr = (chdev_t *)GET_PTR( ioc_xp );
94
95    // get extended pointer on SOCLIB-BDV peripheral
96    xptr_t     bdv_xp = hal_remote_lw( XPTR( ioc_cxy , &ioc_ptr->base ) );
97
98    // get SOCLIB_BDV device cluster and local pointer
99    cxy_t      bdv_cxy = GET_CXY( bdv_xp );
100    uint32_t * bdv_ptr = (uint32_t *)GET_PTR( bdv_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    // set operation
107    uint32_t   op;
108    if( cmd_type == IOC_WRITE ) op = BDV_OP_WRITE; 
109    else                        op = BDV_OP_READ;
110
111    // set SOCLIB_BDV registers to start one I/O operation
112    hal_remote_sw( XPTR( bdv_cxy , bdv_ptr + BDV_IRQ_ENABLE_REG ) , 1       );
113    hal_remote_sw( XPTR( bdv_cxy , bdv_ptr + BDV_BUFFER_REG     ) , buf_lsb ); 
114    hal_remote_sw( XPTR( bdv_cxy , bdv_ptr + BDV_BUFFER_EXT_REG ) , buf_msb ); 
115    hal_remote_sw( XPTR( bdv_cxy , bdv_ptr + BDV_LBA_REG        ) , lba     );
116    hal_remote_sw( XPTR( bdv_cxy , bdv_ptr + BDV_COUNT_REG      ) , count   );
117    hal_remote_sw( XPTR( bdv_cxy , bdv_ptr + BDV_OP_REG         ) , op      );
118
119    // waiting policy  depends on the command type
120    // - for IOC_READ / IOC_WRITE commands, this function is called by the server thread
121    // - for IOC_SYNC_READ command, this function is directly called by the client thread
122
123    if( cmd_type == IOC_SYNC_READ )                   // status polling policy
124    {
125        uint32_t status;
126        while (1)
127        {
128            status = hal_remote_lw( XPTR( bdv_cxy , bdv_ptr + BDV_STATUS_REG ) );
129
130            if( status == BDV_READ_SUCCESS ) // successfully completed
131            {
132                hal_remote_sw( XPTR( th_cxy , &th_ptr->ioc_cmd.error ) , 0 );
133                break;
134            }
135            else if( status == BDV_BUSY )   // non completed
136            {
137                continue;
138            }
139            else                            // error reported
140            {
141                hal_remote_sw( XPTR( th_cxy , &th_ptr->ioc_cmd.error ) , 1 );
142                break;
143            }
144        }
145    }
146    else                                            // descheduling + IRQ policy
147    { 
148        thread_block( XPTR( local_cxy , CURRENT_THREAD ) , THREAD_BLOCKED_ISR );
149        sched_yield("blocked on ISR");
150
151        // the IO operation status is reported in the command by the ISR
152    }
153   
154#if DEBUG_HAL_IOC_RX
155cycle = (uint32_t)hal_get_cycles();
156if( (DEBUG_HAL_IOC_RX < cycle) && (cmd_type != TXT_WRITE) )
157printk("\n[DBG] %s : thread %x exit after RX / cycle %d\n",
158__FUNCTION__ , CURRENT_THREAD , cycle );
159#endif
160
161#if DEBUG_HAL_IOC_TX
162cycle = (uint32_t)hal_get_cycles();
163if( (DEBUG_HAL_IOC_TX < cycle) && (cmd_type == TXT_WRITE) )
164printk("\n[DBG] %s : thread %x exit after TX / cycle %d\n",
165__FUNCTION__ , CURRENT_THREAD , cycle );
166#endif
167
168} // end soclib_bdv_cmd()
169
170
171/////////////////////////////////////////////////////////////////
172void __attribute__ ((noinline)) soclib_bdv_isr( chdev_t * chdev )
173{
174    error_t  error = 0;
175
176    // get extended pointer on client thread
177    xptr_t root = XPTR( local_cxy , &chdev->wait_root );
178    xptr_t client_xp = XLIST_FIRST_ELEMENT( root , thread_t , wait_list );
179
180    // get extended pointer on server thread
181    xptr_t server_xp = XPTR( local_cxy , &chdev->server );
182
183    // get client thread cluster and local pointer
184    cxy_t      client_cxy = GET_CXY( client_xp );
185    thread_t * client_ptr = (thread_t *)GET_PTR( client_xp );
186
187    // get command type
188    uint32_t   cmd_type = hal_remote_lw( XPTR( client_cxy , &client_ptr->ioc_cmd.type ) );
189   
190    // get SOCLIB_BDV device cluster and local pointer
191    cxy_t      bdv_cxy  = GET_CXY( chdev->base );
192    uint32_t * bdv_ptr  = (uint32_t *)GET_PTR( chdev->base );
193
194    // get BDV status register and acknowledge IRQ
195        uint32_t status = hal_remote_lw( XPTR( bdv_cxy , bdv_ptr + BDV_STATUS_REG ) );   
196
197    if( cmd_type == IOC_READ )
198    {
199            error = (status != BDV_READ_SUCCESS);
200
201#if DEBUG_HAL_IOC_RX
202uint32_t cycle = (uint32_t)hal_get_cycles();
203if( DEBUG_HAL_IOC_RX < cycle )
204printk("\n[DBG] %s : IOC_IRQ / RX transfer / client %x / server %x / cycle %d\n",
205__FUNCTION__, client_ptr , chdev->server , cycle );
206#endif
207
208    }
209        else if( cmd_type == IOC_WRITE )
210    {
211            error = (status != BDV_WRITE_SUCCESS);
212
213#if DEBUG_HAL_IOC_TX
214uint32_t cycle = (uint32_t)hal_get_cycles();
215if( DEBUG_HAL_IOC_TX < cycle )
216printk("\n[DBG] %s : IOC_IRQ / RX transfer / client %x / server %x / cycle %d\n",
217__FUNCTION__, client_ptr , chdev->server , cycle );
218#endif
219
220    }
221    else
222    {
223        assert( false , __FUNCTION__ , "IOC_SYNC_READ should not use IRQ" );
224    } 
225
226    // set operation status in command
227    hal_remote_sw( XPTR( client_cxy , &client_ptr->ioc_cmd.error ) , error );
228
229    // unblock server thread
230    thread_unblock( server_xp , THREAD_BLOCKED_ISR );
231
232} // end soclib_bdv_isr()
233
234
235
Note: See TracBrowser for help on using the repository browser.