source: trunk/kernel/devices/dev_mmc.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.1 KB
Line 
1/*
2 * dev_mmc.c - MMC (Memory Cache 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-kernel; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 */
23
24#include <hal_kernel_types.h>
25#include <hal_special.h>
26#include <hal_drivers.h>
27#include <printk.h>
28#include <chdev.h>
29#include <thread.h>
30#include <dev_mmc.h>
31
32/////////////////////////////////////////////////////////////////////////////////////////
33// Extern global variables
34/////////////////////////////////////////////////////////////////////////////////////////
35
36extern chdev_directory_t  chdev_dir;         // allocated in kernel_init.c
37
38//////////////////////////////////
39void dev_mmc_init( chdev_t * mmc )
40{
41    // get implementation from device descriptor
42    uint32_t  impl = mmc->impl;
43
44    // set mmc name
45    snprintf( mmc->name , 16 , "mmc_%x" , local_cxy );
46
47    // call driver init function
48    hal_drivers_mmc_init( mmc , impl );
49
50    // bind IRQ to CP0
51    dev_pic_bind_irq( 0 , mmc );
52   
53    // enable IRQ
54    dev_pic_enable_irq( 0 , XPTR( local_cxy , mmc ) );
55
56}  // end dev_mmc_init()
57
58/////////////////////////////////////////////////////////////////////////////
59// This static function is called by all MMC device access functions.
60// It makes some checking, takes the lock granting exclusive
61// access to MMC peripheral, call the driver to execute the command
62// registered in the calling thread descriptor, and releases the lock.
63/////////////////////////////////////////////////////////////////////////////
64static error_t dev_mmc_access( thread_t * this )
65{
66    // get extended pointer on MMC device descriptor
67    xptr_t  dev_xp = this->mmc_cmd.dev_xp;
68
69    assert( (dev_xp != XPTR_NULL) , "target MMC device undefined" );
70
71    // get MMC device cluster identifier & local pointer
72    cxy_t     dev_cxy = GET_CXY( dev_xp );
73    chdev_t * dev_ptr = GET_PTR( dev_xp );
74
75    // get driver command function pointer from MMC device descriptor
76    dev_cmd_t * cmd = (dev_cmd_t *)hal_remote_lpt( XPTR( dev_cxy , &dev_ptr->cmd ) );
77
78    // get the MMC device remote spinlock
79    remote_spinlock_lock( XPTR( dev_cxy , &dev_ptr->wait_lock ) ); 
80
81    // call driver command
82    cmd( XPTR( local_cxy , this ) );
83   
84    // release the MMC device remote spinlock
85    remote_spinlock_unlock( XPTR( dev_cxy , &dev_ptr->wait_lock ) ); 
86
87    // return operation status
88    return this->mmc_cmd.error; 
89
90}  // end dev_mmc_access()
91
92/////////////////////////////////////////
93error_t dev_mmc_inval( xptr_t     buf_xp,
94                       uint32_t   buf_size )
95{
96    error_t error;
97
98    // get calling thread local pointer
99    thread_t  * this    = CURRENT_THREAD;
100
101#if DEBUG_DEV_MMC
102uint32_t cycle = (uint32_t)hal_get_cycles();
103if( DEBUG_DEV_MMC < cycle )
104printk("\n[DBG] %s : thread %x enters / process %x / buf_xp = %l\n", 
105__FUNCTION__, this, this->process->pid , buf_xp );
106#endif
107
108    // get buffer cluster and local pointer
109    cxy_t  buf_cxy = GET_CXY( buf_xp );
110    void * buf_ptr = GET_PTR( buf_xp );
111   
112    assert( (((intptr_t)buf_ptr & (CONFIG_CACHE_LINE_SIZE -1)) == 0) ,
113             "buffer not aligned on cache line" );
114
115    // store command arguments in thread descriptor
116    this->mmc_cmd.dev_xp    = chdev_dir.mmc[buf_cxy];
117    this->mmc_cmd.type      = MMC_CC_INVAL;
118    this->mmc_cmd.buf_ptr   = buf_ptr;
119    this->mmc_cmd.buf_size  = buf_size;
120
121    // call MMC driver
122    error = dev_mmc_access( this );
123
124#if DEBUG_DEV_MMC
125cycle = (uint32_t)hal_get_cycles();
126if( DEBUG_DEV_MMC < cycle )
127printk("\n[DBG] %s : thread %x exit / process %x / buf_xp = %l\n", 
128__FUNCTION__, this, this->process->pid , buf_xp );
129#endif
130
131    return error;
132}
133
134////////////////////////////////////////
135error_t dev_mmc_sync( xptr_t     buf_xp,
136                      uint32_t   buf_size )
137{
138    error_t error;
139
140    thread_t  * this    = CURRENT_THREAD;
141
142#if DEBUG_DEV_MMC
143uint32_t cycle = (uint32_t)hal_get_cycles();
144if( DEBUG_DEV_MMC < cycle )
145printk("\n[DBG] %s : thread %x enters / process %x / buf_xp = %l\n", 
146__FUNCTION__, this, this->process->pid , buf_xp );
147#endif
148
149    // get buffer cluster and local pointer
150    cxy_t  buf_cxy = GET_CXY( buf_xp );
151    void * buf_ptr = GET_PTR( buf_xp );
152   
153    assert( (((intptr_t)buf_ptr & (CONFIG_CACHE_LINE_SIZE -1)) == 0) ,
154             "buffer not aligned on cache line" );
155
156    // store command arguments in thread descriptor
157    this->mmc_cmd.dev_xp    = chdev_dir.mmc[buf_cxy];
158    this->mmc_cmd.type      = MMC_CC_SYNC;
159    this->mmc_cmd.buf_ptr   = buf_ptr;
160    this->mmc_cmd.buf_size  = buf_size;
161
162    // call MMC driver
163    error = dev_mmc_access( this );
164
165#if DEBUG_DEV_MMC
166cycle = (uint32_t)hal_get_cycles();
167if( DEBUG_DEV_MMC < cycle )
168printk("\n[DBG] %s : thread %x exit / process %x / buf_xp = %l\n", 
169__FUNCTION__, this, this->process->pid , buf_xp );
170#endif
171
172    return error;
173}
174
175/////////////////////////////////////////
176error_t dev_mmc_set_error( cxy_t     cxy,
177                           uint32_t  index,
178                           uint32_t  wdata )
179{
180    // get calling thread local pointer
181    thread_t * this = CURRENT_THREAD;
182
183    // store command arguments in thread descriptor
184    this->mmc_cmd.dev_xp    = chdev_dir.mmc[cxy];
185    this->mmc_cmd.type      = MMC_SET_ERROR;
186    this->mmc_cmd.reg_index = index;
187    this->mmc_cmd.reg_ptr   = &wdata;
188
189    // execute operation
190    return dev_mmc_access( this ); 
191}
192                       
193//////////////////////////////////////////
194error_t dev_mmc_get_error( cxy_t      cxy,
195                           uint32_t   index,
196                           uint32_t * rdata )
197{
198    // get calling thread local pointer
199    thread_t * this = CURRENT_THREAD;
200
201    // store command arguments in thread descriptor
202    this->mmc_cmd.dev_xp    = chdev_dir.mmc[cxy];
203    this->mmc_cmd.type      = MMC_GET_ERROR;
204    this->mmc_cmd.reg_index = index;
205    this->mmc_cmd.reg_ptr   = rdata;
206
207    // execute operation
208    return dev_mmc_access( this ); 
209}
210                       
211////////////////////////////////////////////////////
212error_t dev_mmc_get_instrumentation( cxy_t      cxy,
213                                     uint32_t   index,
214                                     uint32_t * rdata )
215{
216    // get calling thread local pointer
217    thread_t * this = CURRENT_THREAD;
218
219    // store command arguments in thread descriptor
220    this->mmc_cmd.dev_xp    = chdev_dir.mmc[cxy];
221    this->mmc_cmd.type      = MMC_GET_INSTRU;
222    this->mmc_cmd.reg_index = index;
223    this->mmc_cmd.reg_ptr   = rdata;
224
225    // execute operation
226    return dev_mmc_access( this ); 
227}
228
Note: See TracBrowser for help on using the repository browser.