[1] | 1 | /* |
---|
| 2 | * dev_mmc.c - MMC (Memory Cache Controler) generic device API implementation. |
---|
| 3 | * |
---|
[437] | 4 | * Author Alain Greiner (2016,2017,2018) |
---|
[1] | 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_types.h> |
---|
| 25 | #include <hal_special.h> |
---|
[257] | 26 | #include <hal_drivers.h> |
---|
[1] | 27 | #include <printk.h> |
---|
[3] | 28 | #include <chdev.h> |
---|
[1] | 29 | #include <thread.h> |
---|
| 30 | #include <dev_mmc.h> |
---|
| 31 | |
---|
| 32 | ///////////////////////////////////////////////////////////////////////////////////////// |
---|
| 33 | // Extern global variables |
---|
| 34 | ///////////////////////////////////////////////////////////////////////////////////////// |
---|
| 35 | |
---|
[3] | 36 | extern chdev_directory_t chdev_dir; // allocated in kernel_init.c |
---|
[1] | 37 | |
---|
[238] | 38 | ////////////////////////////////// |
---|
| 39 | void dev_mmc_init( chdev_t * mmc ) |
---|
[1] | 40 | { |
---|
| 41 | // get implementation from device descriptor |
---|
[238] | 42 | uint32_t impl = mmc->impl; |
---|
[1] | 43 | |
---|
[238] | 44 | // set mmc name |
---|
| 45 | snprintf( mmc->name , 16 , "mmc_%x" , local_cxy ); |
---|
[23] | 46 | |
---|
[257] | 47 | // call driver init function |
---|
| 48 | hal_drivers_mmc_init( mmc , impl ); |
---|
[14] | 49 | |
---|
[188] | 50 | // bind IRQ to CP0 |
---|
[238] | 51 | dev_pic_bind_irq( 0 , mmc ); |
---|
[188] | 52 | |
---|
| 53 | // enable IRQ |
---|
[238] | 54 | dev_pic_enable_irq( 0 , XPTR( local_cxy , mmc ) ); |
---|
[14] | 55 | |
---|
[1] | 56 | } // end dev_mmc_init() |
---|
| 57 | |
---|
| 58 | ///////////////////////////////////////////////////////////////////////////// |
---|
[23] | 59 | // This static function is called by all MMC device functions. |
---|
| 60 | // It makes some checking, takes the lock granting exclusive |
---|
| 61 | // access to MMC peripheral, call the driver to execute the command |
---|
[1] | 62 | // registered in the calling thread descriptor, and releases the lock. |
---|
| 63 | ///////////////////////////////////////////////////////////////////////////// |
---|
[23] | 64 | static error_t dev_mmc_access( thread_t * this ) |
---|
[1] | 65 | { |
---|
[23] | 66 | // get extended pointer on MMC device descriptor |
---|
[279] | 67 | xptr_t dev_xp = this->mmc_cmd.dev_xp; |
---|
[1] | 68 | |
---|
[23] | 69 | assert( (dev_xp != XPTR_NULL) , __FUNCTION__ , "target MMC device undefined" ); |
---|
[1] | 70 | |
---|
| 71 | // get MMC device cluster identifier & local pointer |
---|
[3] | 72 | cxy_t dev_cxy = GET_CXY( dev_xp ); |
---|
| 73 | chdev_t * dev_ptr = (chdev_t *)GET_PTR( dev_xp ); |
---|
[1] | 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 | |
---|
[23] | 87 | // return operation status |
---|
[279] | 88 | return this->mmc_cmd.error; |
---|
[1] | 89 | |
---|
| 90 | } // end dev_mmc_access() |
---|
| 91 | |
---|
[23] | 92 | ///////////////////////////////////////// |
---|
| 93 | error_t dev_mmc_inval( xptr_t buf_xp, |
---|
[1] | 94 | uint32_t buf_size ) |
---|
| 95 | { |
---|
[23] | 96 | error_t error; |
---|
| 97 | |
---|
[1] | 98 | // get calling thread local pointer |
---|
| 99 | thread_t * this = CURRENT_THREAD; |
---|
| 100 | |
---|
[438] | 101 | #if DEBUG_DEV_MMC |
---|
[437] | 102 | uint32_t cycle = (uint32_t)hal_get_cycles(); |
---|
[438] | 103 | if( DEBUG_DEV_MMC < cycle ) |
---|
[437] | 104 | printk("\n[DBG] %s : thread %x enters / process %x / buf_xp = %l\n", |
---|
| 105 | __FUNCTION__, this, this->process->pid , buf_xp ); |
---|
| 106 | #endif |
---|
[1] | 107 | |
---|
[23] | 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) , __FUNCTION__ , |
---|
[3] | 113 | "buffer not aligned on cache line" ); |
---|
[1] | 114 | |
---|
[23] | 115 | // get buffer physical address |
---|
| 116 | paddr_t buf_paddr; |
---|
| 117 | error = vmm_v2p_translate( CONFIG_KERNEL_IDENTITY_MAP , buf_ptr , &buf_paddr ); |
---|
[1] | 118 | |
---|
[23] | 119 | assert( (error == 0) , __FUNCTION__ , "cannot get buffer paddr" ); |
---|
| 120 | |
---|
[1] | 121 | // store command arguments in thread descriptor |
---|
[279] | 122 | this->mmc_cmd.dev_xp = chdev_dir.mmc[buf_cxy]; |
---|
| 123 | this->mmc_cmd.type = MMC_CC_INVAL; |
---|
| 124 | this->mmc_cmd.buf_paddr = buf_paddr; |
---|
| 125 | this->mmc_cmd.buf_size = buf_size; |
---|
[1] | 126 | |
---|
[23] | 127 | // call MMC driver |
---|
| 128 | error = dev_mmc_access( this ); |
---|
[1] | 129 | |
---|
[438] | 130 | #if DEBUG_DEV_MMC |
---|
[437] | 131 | cycle = (uint32_t)hal_get_cycles(); |
---|
[438] | 132 | if( DEBUG_DEV_MMC < cycle ) |
---|
[437] | 133 | printk("\n[DBG] %s : thread %x exit / process %x / buf_xp = %l\n", |
---|
| 134 | __FUNCTION__, this, this->process->pid , buf_xp ); |
---|
| 135 | #endif |
---|
[1] | 136 | |
---|
[23] | 137 | return error; |
---|
| 138 | } |
---|
| 139 | |
---|
| 140 | //////////////////////////////////////// |
---|
| 141 | error_t dev_mmc_sync( xptr_t buf_xp, |
---|
[1] | 142 | uint32_t buf_size ) |
---|
| 143 | { |
---|
[23] | 144 | error_t error; |
---|
| 145 | |
---|
[1] | 146 | // get calling thread local pointer |
---|
| 147 | thread_t * this = CURRENT_THREAD; |
---|
| 148 | |
---|
[438] | 149 | #if DEBUG_DEV_MMC |
---|
[437] | 150 | uint32_t cycle = (uint32_t)hal_get_cycles(); |
---|
[438] | 151 | if( DEBUG_DEV_MMC < cycle ) |
---|
[437] | 152 | printk("\n[DBG] %s : thread %x enters / process %x / buf_xp = %l\n", |
---|
| 153 | __FUNCTION__, this, this->process->pid , buf_xp ); |
---|
| 154 | #endif |
---|
[1] | 155 | |
---|
[23] | 156 | // get buffer cluster and local pointer |
---|
| 157 | cxy_t buf_cxy = GET_CXY( buf_xp ); |
---|
| 158 | void * buf_ptr = GET_PTR( buf_xp ); |
---|
| 159 | |
---|
| 160 | assert( (((intptr_t)buf_ptr & (CONFIG_CACHE_LINE_SIZE -1)) == 0) , __FUNCTION__ , |
---|
[3] | 161 | "buffer not aligned on cache line" ); |
---|
[1] | 162 | |
---|
[23] | 163 | // get buffer physical address |
---|
| 164 | paddr_t buf_paddr; |
---|
| 165 | error = vmm_v2p_translate( CONFIG_KERNEL_IDENTITY_MAP , buf_ptr , &buf_paddr ); |
---|
| 166 | |
---|
| 167 | assert( (error == 0) , __FUNCTION__ , "cannot get buffer paddr" ); |
---|
| 168 | |
---|
[1] | 169 | // store command arguments in thread descriptor |
---|
[279] | 170 | this->mmc_cmd.dev_xp = chdev_dir.mmc[buf_cxy]; |
---|
| 171 | this->mmc_cmd.type = MMC_CC_SYNC; |
---|
| 172 | this->mmc_cmd.buf_paddr = buf_paddr; |
---|
| 173 | this->mmc_cmd.buf_size = buf_size; |
---|
[1] | 174 | |
---|
[23] | 175 | // call MMC driver |
---|
| 176 | error = dev_mmc_access( this ); |
---|
[1] | 177 | |
---|
[438] | 178 | #if DEBUG_DEV_MMC |
---|
[437] | 179 | cycle = (uint32_t)hal_get_cycles(); |
---|
[438] | 180 | if( DEBUG_DEV_MMC < cycle ) |
---|
[437] | 181 | printk("\n[DBG] %s : thread %x exit / process %x / buf_xp = %l\n", |
---|
| 182 | __FUNCTION__, this, this->process->pid , buf_xp ); |
---|
| 183 | #endif |
---|
[1] | 184 | |
---|
[23] | 185 | return error; |
---|
| 186 | } |
---|
| 187 | |
---|
[1] | 188 | ///////////////////////////////////////// |
---|
| 189 | error_t dev_mmc_set_error( cxy_t cxy, |
---|
| 190 | uint32_t index, |
---|
| 191 | uint32_t wdata ) |
---|
| 192 | { |
---|
| 193 | // get calling thread local pointer |
---|
| 194 | thread_t * this = CURRENT_THREAD; |
---|
| 195 | |
---|
| 196 | // store command arguments in thread descriptor |
---|
[279] | 197 | this->mmc_cmd.dev_xp = chdev_dir.mmc[cxy]; |
---|
| 198 | this->mmc_cmd.type = MMC_SET_ERROR; |
---|
| 199 | this->mmc_cmd.reg_index = index; |
---|
| 200 | this->mmc_cmd.reg_ptr = &wdata; |
---|
[1] | 201 | |
---|
| 202 | // execute operation |
---|
[23] | 203 | return dev_mmc_access( this ); |
---|
[1] | 204 | } |
---|
| 205 | |
---|
| 206 | ////////////////////////////////////////// |
---|
| 207 | error_t dev_mmc_get_error( cxy_t cxy, |
---|
| 208 | uint32_t index, |
---|
| 209 | uint32_t * rdata ) |
---|
| 210 | { |
---|
| 211 | // get calling thread local pointer |
---|
| 212 | thread_t * this = CURRENT_THREAD; |
---|
| 213 | |
---|
| 214 | // store command arguments in thread descriptor |
---|
[279] | 215 | this->mmc_cmd.dev_xp = chdev_dir.mmc[cxy]; |
---|
| 216 | this->mmc_cmd.type = MMC_GET_ERROR; |
---|
| 217 | this->mmc_cmd.reg_index = index; |
---|
| 218 | this->mmc_cmd.reg_ptr = rdata; |
---|
[1] | 219 | |
---|
| 220 | // execute operation |
---|
[23] | 221 | return dev_mmc_access( this ); |
---|
[1] | 222 | } |
---|
| 223 | |
---|
| 224 | //////////////////////////////////////////////////// |
---|
| 225 | error_t dev_mmc_get_instrumentation( cxy_t cxy, |
---|
| 226 | uint32_t index, |
---|
| 227 | uint32_t * rdata ) |
---|
| 228 | { |
---|
| 229 | // get calling thread local pointer |
---|
| 230 | thread_t * this = CURRENT_THREAD; |
---|
| 231 | |
---|
| 232 | // store command arguments in thread descriptor |
---|
[279] | 233 | this->mmc_cmd.dev_xp = chdev_dir.mmc[cxy]; |
---|
| 234 | this->mmc_cmd.type = MMC_GET_INSTRU; |
---|
| 235 | this->mmc_cmd.reg_index = index; |
---|
| 236 | this->mmc_cmd.reg_ptr = rdata; |
---|
[1] | 237 | |
---|
| 238 | // execute operation |
---|
[23] | 239 | return dev_mmc_access( this ); |
---|
[1] | 240 | } |
---|
| 241 | |
---|