2 * Copyright (c) 2013-2015 ARM Limited
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder. You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions are
16 * met: redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer;
18 * redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution;
21 * neither the name of the copyright holders nor the names of its
22 * contributors may be used to endorse or promote products derived from
23 * this software without specific prior written permission.
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 * This is a simulation model for a UFS interface
40 * The UFS interface consists of a host controller and (at least) one device.
41 * The device can contain multiple logic units.
42 * To make this interface as usefull as possible for future development, the
43 * decision has been made to split the UFS functionality from the SCSI
44 * functionality. The class UFS SCSIDevice can therefor be used as a starting
45 * point for creating a more generic SCSI device. This has as a consequence
46 * that the UFSHostDevice class contains functionality from both the host
47 * controller and the device. The current UFS standard (1.1) allows only one
48 * device, and up to 8 logic units. the logic units only handle the SCSI part
49 * of the command, and the device mainly the UFS part. Yet the split between
50 * the SCSIresume function and the SCSICMDHandle might seem a bit awkward.
51 * The SCSICMDHandle function is in essence a SCSI reply generator, and it
52 * distils the essential information from the command. A disktransfer cannot
53 * be made from this position because the scatter gather list is not included
54 * in the SCSI command, but in the Transfer Request descriptor. The device
55 * needs to manage the data transfer. This file is build up as follows: first
56 * the UFSSCSIDevice functions will be presented; then the UFSHostDevice
57 * functions. The UFSHostDevice functions are split in three parts: UFS
58 * transaction flow, data write transfer and data read transfer. The
59 * functions are then ordered in the order in which a transfer takes place.
63 * Reference material can be found at the JEDEC website:
65 * http://www.jedec.org/standards-documents/results/jesd220
66 * UFS HCI specification
67 * http://www.jedec.org/standards-documents/results/jesd223
70 #include "dev/arm/ufs_device.hh"
73 * Constructor and destructor functions of UFSHCM device
75 UFSHostDevice::UFSSCSIDevice::UFSSCSIDevice(const UFSHostDeviceParams
&p
,
76 uint32_t lun_id
, const Callback
&transfer_cb
,
77 const Callback
&read_cb
):
79 flashDisk(p
.image
[lun_id
]),
80 flashDevice(p
.internalflash
[lun_id
]),
81 blkSize(p
.img_blk_size
),
82 lunAvail(p
.image
.size()),
83 diskSize(flashDisk
->size()),
84 capacityLower((diskSize
- 1) & 0xffffffff),
85 capacityUpper((diskSize
- SectorSize
) >> 32),
87 transferCompleted(false),
91 amountOfWriteTransfers(0),
92 amountOfReadTransfers(0)
95 * These callbacks are used to communicate the events that are
96 * triggered upstream; e.g. from the Memory Device to the UFS SCSI Device
97 * or from the UFS SCSI device to the UFS host.
99 signalDone
= transfer_cb
;
100 memReadCallback
= [this]() { readCallback(); };
101 deviceReadCallback
= read_cb
;
102 memWriteCallback
= [this]() { SSDWriteDone(); };
105 * make ascii out of lun_id (and add more characters)
106 * UFS allows up to 8 logic units, so the numbering should work out
108 uint32_t temp_id
= ((lun_id
| 0x30) << 24) | 0x3A4449;
109 lunInfo
.dWord0
= 0x02060000; //data
110 lunInfo
.dWord1
= 0x0200001F;
111 lunInfo
.vendor0
= 0x484D5241; //ARMH (HMRA)
112 lunInfo
.vendor1
= 0x424D4143; //CAMB (BMAC)
113 lunInfo
.product0
= 0x356D6567; //gem5 (5meg)
114 lunInfo
.product1
= 0x4D534655; //UFSM (MSFU)
115 lunInfo
.product2
= 0x4C45444F; //ODEL (LEDO)
116 lunInfo
.product3
= temp_id
; // ID:"lun_id" ("lun_id":DI)
117 lunInfo
.productRevision
= 0x01000000; //0x01
119 DPRINTF(UFSHostDevice
, "Logic unit %d assumes that %d logic units are"
120 " present in the system\n", lunID
, lunAvail
);
121 DPRINTF(UFSHostDevice
,"The disksize of lun: %d should be %d blocks\n",
123 flashDevice
->initializeMemory(diskSize
, SectorSize
);
128 * These pages are SCSI specific. For more information refer to:
129 * Universal Flash Storage (UFS) JESD220 FEB 2011 (JEDEC)
130 * http://www.jedec.org/standards-documents/results/jesd220
132 const unsigned int UFSHostDevice::UFSSCSIDevice::controlPage
[3] =
133 {0x01400A0A, 0x00000000,
135 const unsigned int UFSHostDevice::UFSSCSIDevice::recoveryPage
[3] =
136 {0x03800A01, 0x00000000,
138 const unsigned int UFSHostDevice::UFSSCSIDevice::cachingPage
[5] =
139 {0x00011208, 0x00000000,
140 0x00000000, 0x00000020,
143 UFSHostDevice::UFSSCSIDevice::~UFSSCSIDevice() {}
146 * UFS specific SCSI handling function.
147 * The following attributes may still be added: SCSI format unit,
148 * Send diagnostic and UNMAP;
149 * Synchronize Cache and buffer read/write could not be tested yet
150 * All parameters can be found in:
151 * Universal Flash Storage (UFS) JESD220 FEB 2011 (JEDEC)
152 * http://www.jedec.org/standards-documents/results/jesd220
153 * (a JEDEC acount may be required {free of charge})
156 struct UFSHostDevice::SCSIReply
157 UFSHostDevice::UFSSCSIDevice::SCSICMDHandle(uint32_t* SCSI_msg
)
159 struct SCSIReply scsi_out
;
163 * Create the standard SCSI reponse information
164 * These values might changes over the course of a transfer
166 scsi_out
.message
.header
.dWord0
= UPIUHeaderDataIndWord0
|
168 scsi_out
.message
.header
.dWord1
= UPIUHeaderDataIndWord1
;
169 scsi_out
.message
.header
.dWord2
= UPIUHeaderDataIndWord2
;
170 statusCheck(SCSIGood
, scsi_out
.senseCode
);
171 scsi_out
.senseSize
= scsi_out
.senseCode
[0];
172 scsi_out
.LUN
= lunID
;
173 scsi_out
.status
= SCSIGood
;
175 DPRINTF(UFSHostDevice
, "SCSI command:%2x\n", SCSI_msg
[4]);
176 /**Determine what the message is and fill the response packet*/
178 switch (SCSI_msg
[4] & 0xFF) {
182 * SCSI inquiry: tell about this specific logic unit
184 scsi_out
.msgSize
= 36;
185 scsi_out
.message
.dataMsg
.resize(9);
187 for (uint8_t count
= 0; count
< 9; count
++)
188 scsi_out
.message
.dataMsg
[count
] =
189 (reinterpret_cast<uint32_t*> (&lunInfo
))[count
];
194 * Read command. Number indicates the length of the command.
196 scsi_out
.expectMore
= 0x02;
197 scsi_out
.msgSize
= 0;
199 uint8_t* tempptr
= reinterpret_cast<uint8_t*>(&SCSI_msg
[4]);
201 /**BE and not nicely aligned. Apart from that it only has
202 * information in five bits of the first byte that is relevant
205 uint32_t tmp
= *reinterpret_cast<uint32_t*>(tempptr
);
206 uint64_t read_offset
= betoh(tmp
) & 0x1FFFFF;
208 uint32_t read_size
= tempptr
[4];
211 scsi_out
.msgSize
= read_size
* blkSize
;
212 scsi_out
.offset
= read_offset
* blkSize
;
214 if ((read_offset
+ read_size
) > diskSize
)
215 scsi_out
.status
= SCSIIllegalRequest
;
217 DPRINTF(UFSHostDevice
, "Read6 offset: 0x%8x, for %d blocks\n",
218 read_offset
, read_size
);
221 * Renew status check, for the request may have been illegal
223 statusCheck(scsi_out
.status
, scsi_out
.senseCode
);
224 scsi_out
.senseSize
= scsi_out
.senseCode
[0];
225 scsi_out
.status
= (scsi_out
.status
== SCSIGood
) ? SCSIGood
:
231 scsi_out
.expectMore
= 0x02;
232 scsi_out
.msgSize
= 0;
234 uint8_t* tempptr
= reinterpret_cast<uint8_t*>(&SCSI_msg
[4]);
236 /**BE and not nicely aligned.*/
237 uint32_t tmp
= *reinterpret_cast<uint32_t*>(&tempptr
[2]);
238 uint64_t read_offset
= betoh(tmp
);
240 uint16_t tmpsize
= *reinterpret_cast<uint16_t*>(&tempptr
[7]);
241 uint32_t read_size
= betoh(tmpsize
);
243 scsi_out
.msgSize
= read_size
* blkSize
;
244 scsi_out
.offset
= read_offset
* blkSize
;
246 if ((read_offset
+ read_size
) > diskSize
)
247 scsi_out
.status
= SCSIIllegalRequest
;
249 DPRINTF(UFSHostDevice
, "Read10 offset: 0x%8x, for %d blocks\n",
250 read_offset
, read_size
);
253 * Renew status check, for the request may have been illegal
255 statusCheck(scsi_out
.status
, scsi_out
.senseCode
);
256 scsi_out
.senseSize
= scsi_out
.senseCode
[0];
257 scsi_out
.status
= (scsi_out
.status
== SCSIGood
) ? SCSIGood
:
263 scsi_out
.expectMore
= 0x02;
264 scsi_out
.msgSize
= 0;
266 uint8_t* tempptr
= reinterpret_cast<uint8_t*>(&SCSI_msg
[4]);
268 /**BE and not nicely aligned.*/
269 uint32_t tmp
= *reinterpret_cast<uint32_t*>(&tempptr
[2]);
270 uint64_t read_offset
= betoh(tmp
);
272 tmp
= *reinterpret_cast<uint32_t*>(&tempptr
[6]);
273 read_offset
= (read_offset
<< 32) | betoh(tmp
);
275 tmp
= *reinterpret_cast<uint32_t*>(&tempptr
[10]);
276 uint32_t read_size
= betoh(tmp
);
278 scsi_out
.msgSize
= read_size
* blkSize
;
279 scsi_out
.offset
= read_offset
* blkSize
;
281 if ((read_offset
+ read_size
) > diskSize
)
282 scsi_out
.status
= SCSIIllegalRequest
;
284 DPRINTF(UFSHostDevice
, "Read16 offset: 0x%8x, for %d blocks\n",
285 read_offset
, read_size
);
288 * Renew status check, for the request may have been illegal
290 statusCheck(scsi_out
.status
, scsi_out
.senseCode
);
291 scsi_out
.senseSize
= scsi_out
.senseCode
[0];
292 scsi_out
.status
= (scsi_out
.status
== SCSIGood
) ? SCSIGood
:
297 case SCSIReadCapacity10
: {
299 * read the capacity of the device
301 scsi_out
.msgSize
= 8;
302 scsi_out
.message
.dataMsg
.resize(2);
303 scsi_out
.message
.dataMsg
[0] =
304 betoh(capacityLower
);//last block
305 scsi_out
.message
.dataMsg
[1] = betoh(blkSize
);//blocksize
308 case SCSIReadCapacity16
: {
309 scsi_out
.msgSize
= 32;
310 scsi_out
.message
.dataMsg
.resize(8);
311 scsi_out
.message
.dataMsg
[0] =
312 betoh(capacityUpper
);//last block
313 scsi_out
.message
.dataMsg
[1] =
314 betoh(capacityLower
);//last block
315 scsi_out
.message
.dataMsg
[2] = betoh(blkSize
);//blocksize
316 scsi_out
.message
.dataMsg
[3] = 0x00;//
317 scsi_out
.message
.dataMsg
[4] = 0x00;//reserved
318 scsi_out
.message
.dataMsg
[5] = 0x00;//reserved
319 scsi_out
.message
.dataMsg
[6] = 0x00;//reserved
320 scsi_out
.message
.dataMsg
[7] = 0x00;//reserved
324 case SCSIReportLUNs
: {
326 * Find out how many Logic Units this device has.
328 scsi_out
.msgSize
= (lunAvail
* 8) + 8;//list + overhead
329 scsi_out
.message
.dataMsg
.resize(2 * lunAvail
+ 2);
330 scsi_out
.message
.dataMsg
[0] = (lunAvail
* 8) << 24;//LUN listlength
331 scsi_out
.message
.dataMsg
[1] = 0x00;
333 for (uint8_t count
= 0; count
< lunAvail
; count
++) {
335 scsi_out
.message
.dataMsg
[2 + 2 * count
] = (count
& 0x7F) << 8;
336 scsi_out
.message
.dataMsg
[3 + 2 * count
] = 0x00;
341 case SCSIStartStop
: {
342 //Just acknowledge; not deemed relevant ATM
343 scsi_out
.msgSize
= 0;
347 case SCSITestUnitReady
: {
348 //Just acknowledge; not deemed relevant ATM
349 scsi_out
.msgSize
= 0;
355 * See if the blocks that the host plans to request are in range of
358 scsi_out
.msgSize
= 0;
360 uint8_t* tempptr
= reinterpret_cast<uint8_t*>(&SCSI_msg
[4]);
362 /**BE and not nicely aligned.*/
363 uint32_t tmp
= *reinterpret_cast<uint32_t*>(&tempptr
[2]);
364 uint64_t read_offset
= betoh(tmp
);
366 uint16_t tmpsize
= *reinterpret_cast<uint16_t*>(&tempptr
[7]);
367 uint32_t read_size
= betoh(tmpsize
);
369 if ((read_offset
+ read_size
) > diskSize
)
370 scsi_out
.status
= SCSIIllegalRequest
;
373 * Renew status check, for the request may have been illegal
375 statusCheck(scsi_out
.status
, scsi_out
.senseCode
);
376 scsi_out
.senseSize
= scsi_out
.senseCode
[0];
377 scsi_out
.status
= (scsi_out
.status
== SCSIGood
) ? SCSIGood
:
387 uint8_t* tempptr
= reinterpret_cast<uint8_t*>(&SCSI_msg
[4]);
389 /**BE and not nicely aligned. Apart from that it only has
390 * information in five bits of the first byte that is relevant
393 uint32_t tmp
= *reinterpret_cast<uint32_t*>(tempptr
);
394 uint64_t write_offset
= betoh(tmp
) & 0x1FFFFF;
396 uint32_t write_size
= tempptr
[4];
398 scsi_out
.msgSize
= write_size
* blkSize
;
399 scsi_out
.offset
= write_offset
* blkSize
;
400 scsi_out
.expectMore
= 0x01;
402 if ((write_offset
+ write_size
) > diskSize
)
403 scsi_out
.status
= SCSIIllegalRequest
;
405 DPRINTF(UFSHostDevice
, "Write6 offset: 0x%8x, for %d blocks\n",
406 write_offset
, write_size
);
409 * Renew status check, for the request may have been illegal
411 statusCheck(scsi_out
.status
, scsi_out
.senseCode
);
412 scsi_out
.senseSize
= scsi_out
.senseCode
[0];
413 scsi_out
.status
= (scsi_out
.status
== SCSIGood
) ? SCSIGood
:
419 uint8_t* tempptr
= reinterpret_cast<uint8_t*>(&SCSI_msg
[4]);
421 /**BE and not nicely aligned.*/
422 uint32_t tmp
= *reinterpret_cast<uint32_t*>(&tempptr
[2]);
423 uint64_t write_offset
= betoh(tmp
);
425 uint16_t tmpsize
= *reinterpret_cast<uint16_t*>(&tempptr
[7]);
426 uint32_t write_size
= betoh(tmpsize
);
428 scsi_out
.msgSize
= write_size
* blkSize
;
429 scsi_out
.offset
= write_offset
* blkSize
;
430 scsi_out
.expectMore
= 0x01;
432 if ((write_offset
+ write_size
) > diskSize
)
433 scsi_out
.status
= SCSIIllegalRequest
;
435 DPRINTF(UFSHostDevice
, "Write10 offset: 0x%8x, for %d blocks\n",
436 write_offset
, write_size
);
439 * Renew status check, for the request may have been illegal
441 statusCheck(scsi_out
.status
, scsi_out
.senseCode
);
442 scsi_out
.senseSize
= scsi_out
.senseCode
[0];
443 scsi_out
.status
= (scsi_out
.status
== SCSIGood
) ? SCSIGood
:
449 uint8_t* tempptr
= reinterpret_cast<uint8_t*>(&SCSI_msg
[4]);
451 /**BE and not nicely aligned.*/
452 uint32_t tmp
= *reinterpret_cast<uint32_t*>(&tempptr
[2]);
453 uint64_t write_offset
= betoh(tmp
);
455 tmp
= *reinterpret_cast<uint32_t*>(&tempptr
[6]);
456 write_offset
= (write_offset
<< 32) | betoh(tmp
);
458 tmp
= *reinterpret_cast<uint32_t*>(&tempptr
[10]);
459 uint32_t write_size
= betoh(tmp
);
461 scsi_out
.msgSize
= write_size
* blkSize
;
462 scsi_out
.offset
= write_offset
* blkSize
;
463 scsi_out
.expectMore
= 0x01;
465 if ((write_offset
+ write_size
) > diskSize
)
466 scsi_out
.status
= SCSIIllegalRequest
;
468 DPRINTF(UFSHostDevice
, "Write16 offset: 0x%8x, for %d blocks\n",
469 write_offset
, write_size
);
472 * Renew status check, for the request may have been illegal
474 statusCheck(scsi_out
.status
, scsi_out
.senseCode
);
475 scsi_out
.senseSize
= scsi_out
.senseCode
[0];
476 scsi_out
.status
= (scsi_out
.status
== SCSIGood
) ? SCSIGood
:
481 case SCSIFormatUnit
: {//not yet verified
482 scsi_out
.msgSize
= 0;
483 scsi_out
.expectMore
= 0x01;
487 case SCSISendDiagnostic
: {//not yet verified
488 scsi_out
.msgSize
= 0;
492 case SCSISynchronizeCache
: {
493 //do we have cache (we don't have cache at this moment)
494 //TODO: here will synchronization happen when cache is modelled
495 scsi_out
.msgSize
= 0;
499 //UFS SCSI additional command set for full functionality
500 case SCSIModeSelect10
:
502 //scsi_out.expectMore = 0x01;//not supported due to modepage support
503 //code isn't dead, code suggest what is to be done when implemented
506 case SCSIModeSense6
: case SCSIModeSense10
: {
508 * Get more discriptive information about the SCSI functionality
509 * within this logic unit.
511 if ((SCSI_msg
[4] & 0x3F0000) >> 16 == 0x0A) {//control page
512 scsi_out
.message
.dataMsg
.resize((sizeof(controlPage
) >> 2) + 2);
513 scsi_out
.message
.dataMsg
[0] = 0x00000A00;//control page code
514 scsi_out
.message
.dataMsg
[1] = 0x00000000;//See JEDEC220 ch8
516 for (uint8_t count
= 0; count
< 3; count
++)
517 scsi_out
.message
.dataMsg
[2 + count
] = controlPage
[count
];
519 scsi_out
.msgSize
= 20;
520 DPRINTF(UFSHostDevice
, "CONTROL page\n");
522 } else if ((SCSI_msg
[4] & 0x3F0000) >> 16 == 0x01) {//recovery page
523 scsi_out
.message
.dataMsg
.resize((sizeof(recoveryPage
) >> 2)
526 scsi_out
.message
.dataMsg
[0] = 0x00000100;//recovery page code
527 scsi_out
.message
.dataMsg
[1] = 0x00000000;//See JEDEC220 ch8
529 for (uint8_t count
= 0; count
< 3; count
++)
530 scsi_out
.message
.dataMsg
[2 + count
] = recoveryPage
[count
];
532 scsi_out
.msgSize
= 20;
533 DPRINTF(UFSHostDevice
, "RECOVERY page\n");
535 } else if ((SCSI_msg
[4] & 0x3F0000) >> 16 == 0x08) {//caching page
537 scsi_out
.message
.dataMsg
.resize((sizeof(cachingPage
) >> 2) + 2);
538 scsi_out
.message
.dataMsg
[0] = 0x00001200;//caching page code
539 scsi_out
.message
.dataMsg
[1] = 0x00000000;//See JEDEC220 ch8
541 for (uint8_t count
= 0; count
< 5; count
++)
542 scsi_out
.message
.dataMsg
[2 + count
] = cachingPage
[count
];
544 scsi_out
.msgSize
= 20;
545 DPRINTF(UFSHostDevice
, "CACHE page\n");
547 } else if ((SCSI_msg
[4] & 0x3F0000) >> 16 == 0x3F) {//ALL the pages!
549 scsi_out
.message
.dataMsg
.resize(((sizeof(controlPage
) +
550 sizeof(recoveryPage
) +
551 sizeof(cachingPage
)) >> 2)
553 scsi_out
.message
.dataMsg
[0] = 0x00003200;//all page code
554 scsi_out
.message
.dataMsg
[1] = 0x00000000;//See JEDEC220 ch8
556 for (uint8_t count
= 0; count
< 3; count
++)
557 scsi_out
.message
.dataMsg
[2 + count
] = recoveryPage
[count
];
559 for (uint8_t count
= 0; count
< 5; count
++)
560 scsi_out
.message
.dataMsg
[5 + count
] = cachingPage
[count
];
562 for (uint8_t count
= 0; count
< 3; count
++)
563 scsi_out
.message
.dataMsg
[10 + count
] = controlPage
[count
];
565 scsi_out
.msgSize
= 52;
566 DPRINTF(UFSHostDevice
, "Return ALL the pages!!!\n");
568 } else inform("Wrong mode page requested\n");
570 scsi_out
.message
.dataCount
= scsi_out
.msgSize
<< 24;
573 case SCSIRequestSense
: {
574 scsi_out
.msgSize
= 0;
578 case SCSIUnmap
:break;//not yet verified
580 case SCSIWriteBuffer
: {
581 scsi_out
.expectMore
= 0x01;
583 uint8_t* tempptr
= reinterpret_cast<uint8_t*>(&SCSI_msg
[4]);
585 /**BE and not nicely aligned.*/
586 uint32_t tmp
= *reinterpret_cast<uint32_t*>(&tempptr
[2]);
587 uint64_t write_offset
= betoh(tmp
) & 0xFFFFFF;
589 tmp
= *reinterpret_cast<uint32_t*>(&tempptr
[5]);
590 uint32_t write_size
= betoh(tmp
) & 0xFFFFFF;
592 scsi_out
.msgSize
= write_size
;
593 scsi_out
.offset
= write_offset
;
597 case SCSIReadBuffer
: {
599 * less trivial than normal read. Size is in bytes instead
600 * of blocks, and it is assumed (though not guaranteed) that
601 * reading is from cache.
603 scsi_out
.expectMore
= 0x02;
605 uint8_t* tempptr
= reinterpret_cast<uint8_t*>(&SCSI_msg
[4]);
607 /**BE and not nicely aligned.*/
608 uint32_t tmp
= *reinterpret_cast<uint32_t*>(&tempptr
[2]);
609 uint64_t read_offset
= betoh(tmp
) & 0xFFFFFF;
611 tmp
= *reinterpret_cast<uint32_t*>(&tempptr
[5]);
612 uint32_t read_size
= betoh(tmp
) & 0xFFFFFF;
614 scsi_out
.msgSize
= read_size
;
615 scsi_out
.offset
= read_offset
;
617 if ((read_offset
+ read_size
) > capacityLower
* blkSize
)
618 scsi_out
.status
= SCSIIllegalRequest
;
620 DPRINTF(UFSHostDevice
, "Read buffer location: 0x%8x\n",
622 DPRINTF(UFSHostDevice
, "Number of bytes: 0x%8x\n", read_size
);
624 statusCheck(scsi_out
.status
, scsi_out
.senseCode
);
625 scsi_out
.senseSize
= scsi_out
.senseCode
[0];
626 scsi_out
.status
= (scsi_out
.status
== SCSIGood
) ? SCSIGood
:
631 case SCSIMaintenanceIn
: {
633 * linux sends this command three times from kernel 3.9 onwards,
634 * UFS does not support it, nor does this model. Linux knows this,
635 * but tries anyway (useful for some SD card types).
636 * Lets make clear we don't want it and just ignore it.
638 DPRINTF(UFSHostDevice
, "Ignoring Maintenance In command\n");
639 statusCheck(SCSIIllegalRequest
, scsi_out
.senseCode
);
640 scsi_out
.senseSize
= scsi_out
.senseCode
[0];
641 scsi_out
.status
= (scsi_out
.status
== SCSIGood
) ? SCSIGood
:
643 scsi_out
.msgSize
= 0;
647 statusCheck(SCSIIllegalRequest
, scsi_out
.senseCode
);
648 scsi_out
.senseSize
= scsi_out
.senseCode
[0];
649 scsi_out
.status
= (scsi_out
.status
== SCSIGood
) ? SCSIGood
:
651 scsi_out
.msgSize
= 0;
652 inform("Unsupported scsi message type: %2x\n", SCSI_msg
[4] & 0xFF);
653 inform("0x%8x\n", SCSI_msg
[0]);
654 inform("0x%8x\n", SCSI_msg
[1]);
655 inform("0x%8x\n", SCSI_msg
[2]);
656 inform("0x%8x\n", SCSI_msg
[3]);
657 inform("0x%8x\n", SCSI_msg
[4]);
665 * SCSI status check function. generic device test, creates sense codes
666 * Future versions may include TODO: device checks, which is why this is
667 * in a separate function.
671 UFSHostDevice::UFSSCSIDevice::statusCheck(uint8_t status
,
672 uint8_t* sensecodelist
)
674 for (uint8_t count
= 0; count
< 19; count
++)
675 sensecodelist
[count
] = 0;
677 sensecodelist
[0] = 18; //sense length
678 sensecodelist
[1] = 0x70; //we send a valid frame
679 sensecodelist
[3] = status
& 0xF; //mask to be sure + sensecode
680 sensecodelist
[8] = 0x1F; //data length
684 * read from the flashdisk
688 UFSHostDevice::UFSSCSIDevice::readFlash(uint8_t* readaddr
, uint64_t offset
,
691 /** read from image, and get to memory */
692 for (int count
= 0; count
< (size
/ SectorSize
); count
++)
693 flashDisk
->read(&(readaddr
[SectorSize
*count
]), (offset
/
694 SectorSize
) + count
);
698 * Write to the flashdisk
702 UFSHostDevice::UFSSCSIDevice::writeFlash(uint8_t* writeaddr
, uint64_t offset
,
705 /** Get from fifo and write to image*/
706 for (int count
= 0; count
< (size
/ SectorSize
); count
++)
707 flashDisk
->write(&(writeaddr
[SectorSize
* count
]),
708 (offset
/ SectorSize
) + count
);
712 * Constructor for the UFS Host device
715 UFSHostDevice::UFSHostDevice(const UFSHostDeviceParams
&p
) :
719 pioDelay(p
.pio_latency
),
722 lunAvail(p
.image
.size()),
723 UFSSlots(p
.ufs_slots
- 1),
733 SCSIResumeEvent([this]{ SCSIStart(); }, name()),
734 UTPEvent([this]{ finalUTP(); }, name())
736 DPRINTF(UFSHostDevice
, "The hostcontroller hosts %d Logic units\n",
738 UFSDevice
.resize(lunAvail
);
740 for (int count
= 0; count
< lunAvail
; count
++) {
741 UFSDevice
[count
] = new UFSSCSIDevice(p
, count
,
742 [this]() { LUNSignal(); },
743 [this]() { readCallback(); });
747 warn("UFSSlots = %d, this will results in %d command slots",
748 UFSSlots
, (UFSSlots
& 0x1F));
750 if ((UFSSlots
& 0x1F) == 0)
751 fatal("Number of UFS command slots should be between 1 and 32.");
757 UFSHostDeviceStats::UFSHostDeviceStats(UFSHostDevice
*parent
)
758 : Stats::Group(parent
, "UFSDiskHost"),
759 ADD_STAT(currentSCSIQueue
,
760 "Most up to date length of the command queue"),
761 ADD_STAT(currentReadSSDQueue
,
762 "Most up to date length of the read SSD queue"),
763 ADD_STAT(currentWriteSSDQueue
,
764 "Most up to date length of the write SSD queue"),
765 /** Amount of data read/written */
766 ADD_STAT(totalReadSSD
, "Number of bytes read from SSD"),
767 ADD_STAT(totalWrittenSSD
, "Number of bytes written to SSD"),
768 ADD_STAT(totalReadDiskTransactions
,"Number of transactions from disk"),
769 ADD_STAT(totalWriteDiskTransactions
, "Number of transactions to disk"),
770 ADD_STAT(totalReadUFSTransactions
, "Number of transactions from device"),
771 ADD_STAT(totalWriteUFSTransactions
, "Number of transactions to device"),
772 /** Average bandwidth for reads and writes */
773 ADD_STAT(averageReadSSDBW
, "Average read bandwidth (bytes/s)",
774 totalReadSSD
/ simSeconds
),
775 ADD_STAT(averageWriteSSDBW
, "Average write bandwidth (bytes/s)",
776 totalWrittenSSD
/ simSeconds
),
777 ADD_STAT(averageSCSIQueue
, "Average command queue length"),
778 ADD_STAT(averageReadSSDQueue
, "Average read queue length"),
779 ADD_STAT(averageWriteSSDQueue
, "Average write queue length"),
780 /** Number of doorbells rung*/
781 ADD_STAT(curDoorbell
, "Most up to date number of doorbells used",
782 parent
->activeDoorbells
),
783 ADD_STAT(maxDoorbell
, "Maximum number of doorbells utilized"),
784 ADD_STAT(averageDoorbell
, "Average number of Doorbells used"),
786 ADD_STAT(transactionLatency
, "Histogram of transaction times"),
787 ADD_STAT(idleTimes
, "Histogram of idle times")
789 using namespace Stats
;
791 // Register the stats
800 /** Amount of data read/written */
807 totalReadDiskTransactions
809 totalWriteDiskTransactions
811 totalReadUFSTransactions
813 totalWriteUFSTransactions
816 /** Average bandwidth for reads and writes */
830 /** Number of doorbells rung*/
852 void UFSHostDevice::setValues()
855 * The capability register is built up as follows:
856 * 31-29 RES; Testmode support; O3 delivery; 64 bit addr;
857 * 23-19 RES; 18-16 #TM Req slots; 15-5 RES;4-0 # TR slots
859 UFSHCIMem
.HCCAP
= 0x06070000 | (UFSSlots
& 0x1F);
860 UFSHCIMem
.HCversion
= 0x00010000; //version is 1.0
861 UFSHCIMem
.HCHCDDID
= 0xAA003C3C;// Arbitrary number
862 UFSHCIMem
.HCHCPMID
= 0x41524D48; //ARMH (not an official MIPI number)
863 UFSHCIMem
.TRUTRLDBR
= 0x00;
864 UFSHCIMem
.TMUTMRLDBR
= 0x00;
865 UFSHCIMem
.CMDUICCMDR
= 0x00;
866 // We can process CMD, TM, TR, device present
867 UFSHCIMem
.ORHostControllerStatus
= 0x08;
868 UFSHCIMem
.TRUTRLBA
= 0x00;
869 UFSHCIMem
.TRUTRLBAU
= 0x00;
870 UFSHCIMem
.TMUTMRLBA
= 0x00;
871 UFSHCIMem
.TMUTMRLBAU
= 0x00;
875 * Determine address ranges
879 UFSHostDevice::getAddrRanges() const
881 AddrRangeList ranges
;
882 ranges
.push_back(RangeSize(pioAddr
, pioSize
));
887 * UFSHCD read register. This function allows the system to read the
892 UFSHostDevice::read(PacketPtr pkt
)
896 switch (pkt
->getAddr() & 0xFF)
899 case regControllerCapabilities
:
900 data
= UFSHCIMem
.HCCAP
;
904 data
= UFSHCIMem
.HCversion
;
907 case regControllerDEVID
:
908 data
= UFSHCIMem
.HCHCDDID
;
911 case regControllerPRODID
:
912 data
= UFSHCIMem
.HCHCPMID
;
915 case regInterruptStatus
:
916 data
= UFSHCIMem
.ORInterruptStatus
;
917 UFSHCIMem
.ORInterruptStatus
= 0x00;
918 //TODO: Revise and extend
922 case regInterruptEnable
:
923 data
= UFSHCIMem
.ORInterruptEnable
;
926 case regControllerStatus
:
927 data
= UFSHCIMem
.ORHostControllerStatus
;
930 case regControllerEnable
:
931 data
= UFSHCIMem
.ORHostControllerEnable
;
934 case regUICErrorCodePHYAdapterLayer
:
935 data
= UFSHCIMem
.ORUECPA
;
938 case regUICErrorCodeDataLinkLayer
:
939 data
= UFSHCIMem
.ORUECDL
;
942 case regUICErrorCodeNetworkLayer
:
943 data
= UFSHCIMem
.ORUECN
;
946 case regUICErrorCodeTransportLayer
:
947 data
= UFSHCIMem
.ORUECT
;
950 case regUICErrorCodeDME
:
951 data
= UFSHCIMem
.ORUECDME
;
954 case regUTPTransferREQINTAGGControl
:
955 data
= UFSHCIMem
.ORUTRIACR
;
958 case regUTPTransferREQListBaseL
:
959 data
= UFSHCIMem
.TRUTRLBA
;
962 case regUTPTransferREQListBaseH
:
963 data
= UFSHCIMem
.TRUTRLBAU
;
966 case regUTPTransferREQDoorbell
:
967 data
= UFSHCIMem
.TRUTRLDBR
;
970 case regUTPTransferREQListClear
:
971 data
= UFSHCIMem
.TRUTRLCLR
;
974 case regUTPTransferREQListRunStop
:
975 data
= UFSHCIMem
.TRUTRLRSR
;
978 case regUTPTaskREQListBaseL
:
979 data
= UFSHCIMem
.TMUTMRLBA
;
982 case regUTPTaskREQListBaseH
:
983 data
= UFSHCIMem
.TMUTMRLBAU
;
986 case regUTPTaskREQDoorbell
:
987 data
= UFSHCIMem
.TMUTMRLDBR
;
990 case regUTPTaskREQListClear
:
991 data
= UFSHCIMem
.TMUTMRLCLR
;
994 case regUTPTaskREQListRunStop
:
995 data
= UFSHCIMem
.TMUTMRLRSR
;
999 data
= UFSHCIMem
.CMDUICCMDR
;
1002 case regUICCommandArg1
:
1003 data
= UFSHCIMem
.CMDUCMDARG1
;
1006 case regUICCommandArg2
:
1007 data
= UFSHCIMem
.CMDUCMDARG2
;
1010 case regUICCommandArg3
:
1011 data
= UFSHCIMem
.CMDUCMDARG3
;
1019 pkt
->setLE
<uint32_t>(data
);
1020 pkt
->makeResponse();
1025 * UFSHCD write function. This function allows access to the writeable
1026 * registers. If any function attempts to write value to an unwriteable
1027 * register entry, then the value will not be written.
1030 UFSHostDevice::write(PacketPtr pkt
)
1034 switch (pkt
->getSize()) {
1037 data
= pkt
->getLE
<uint8_t>();
1041 data
= pkt
->getLE
<uint16_t>();
1045 data
= pkt
->getLE
<uint32_t>();
1049 panic("Undefined UFSHCD controller write size!\n");
1053 switch (pkt
->getAddr() & 0xFF)
1055 case regControllerCapabilities
://you shall not write to this
1058 case regUFSVersion
://you shall not write to this
1061 case regControllerDEVID
://you shall not write to this
1064 case regControllerPRODID
://you shall not write to this
1067 case regInterruptStatus
://you shall not write to this
1070 case regInterruptEnable
:
1071 UFSHCIMem
.ORInterruptEnable
= data
;
1074 case regControllerStatus
:
1075 UFSHCIMem
.ORHostControllerStatus
= data
;
1078 case regControllerEnable
:
1079 UFSHCIMem
.ORHostControllerEnable
= data
;
1082 case regUICErrorCodePHYAdapterLayer
:
1083 UFSHCIMem
.ORUECPA
= data
;
1086 case regUICErrorCodeDataLinkLayer
:
1087 UFSHCIMem
.ORUECDL
= data
;
1090 case regUICErrorCodeNetworkLayer
:
1091 UFSHCIMem
.ORUECN
= data
;
1094 case regUICErrorCodeTransportLayer
:
1095 UFSHCIMem
.ORUECT
= data
;
1098 case regUICErrorCodeDME
:
1099 UFSHCIMem
.ORUECDME
= data
;
1102 case regUTPTransferREQINTAGGControl
:
1103 UFSHCIMem
.ORUTRIACR
= data
;
1106 case regUTPTransferREQListBaseL
:
1107 UFSHCIMem
.TRUTRLBA
= data
;
1108 if (((UFSHCIMem
.TRUTRLBA
| UFSHCIMem
.TRUTRLBAU
) != 0x00) &&
1109 ((UFSHCIMem
.TMUTMRLBA
| UFSHCIMem
.TMUTMRLBAU
)!= 0x00))
1110 UFSHCIMem
.ORHostControllerStatus
|= UICCommandReady
;
1113 case regUTPTransferREQListBaseH
:
1114 UFSHCIMem
.TRUTRLBAU
= data
;
1115 if (((UFSHCIMem
.TRUTRLBA
| UFSHCIMem
.TRUTRLBAU
) != 0x00) &&
1116 ((UFSHCIMem
.TMUTMRLBA
| UFSHCIMem
.TMUTMRLBAU
) != 0x00))
1117 UFSHCIMem
.ORHostControllerStatus
|= UICCommandReady
;
1120 case regUTPTransferREQDoorbell
:
1121 if (!(UFSHCIMem
.TRUTRLDBR
) && data
)
1122 stats
.idleTimes
.sample(curTick() - idlePhaseStart
);
1123 UFSHCIMem
.TRUTRLDBR
|= data
;
1127 case regUTPTransferREQListClear
:
1128 UFSHCIMem
.TRUTRLCLR
= data
;
1131 case regUTPTransferREQListRunStop
:
1132 UFSHCIMem
.TRUTRLRSR
= data
;
1135 case regUTPTaskREQListBaseL
:
1136 UFSHCIMem
.TMUTMRLBA
= data
;
1137 if (((UFSHCIMem
.TRUTRLBA
| UFSHCIMem
.TRUTRLBAU
) != 0x00) &&
1138 ((UFSHCIMem
.TMUTMRLBA
| UFSHCIMem
.TMUTMRLBAU
) != 0x00))
1139 UFSHCIMem
.ORHostControllerStatus
|= UICCommandReady
;
1142 case regUTPTaskREQListBaseH
:
1143 UFSHCIMem
.TMUTMRLBAU
= data
;
1144 if (((UFSHCIMem
.TRUTRLBA
| UFSHCIMem
.TRUTRLBAU
) != 0x00) &&
1145 ((UFSHCIMem
.TMUTMRLBA
| UFSHCIMem
.TMUTMRLBAU
) != 0x00))
1146 UFSHCIMem
.ORHostControllerStatus
|= UICCommandReady
;
1149 case regUTPTaskREQDoorbell
:
1150 UFSHCIMem
.TMUTMRLDBR
|= data
;
1154 case regUTPTaskREQListClear
:
1155 UFSHCIMem
.TMUTMRLCLR
= data
;
1158 case regUTPTaskREQListRunStop
:
1159 UFSHCIMem
.TMUTMRLRSR
= data
;
1163 UFSHCIMem
.CMDUICCMDR
= data
;
1167 case regUICCommandArg1
:
1168 UFSHCIMem
.CMDUCMDARG1
= data
;
1171 case regUICCommandArg2
:
1172 UFSHCIMem
.CMDUCMDARG2
= data
;
1175 case regUICCommandArg3
:
1176 UFSHCIMem
.CMDUCMDARG3
= data
;
1179 default:break;//nothing happens, you try to access a register that
1184 pkt
->makeResponse();
1189 * Request handler. Determines where the request comes from and initiates the
1190 * appropriate actions accordingly.
1194 UFSHostDevice::requestHandler()
1196 Addr address
= 0x00;
1200 struct taskStart task_info
;
1201 struct transferStart transferstart_info
;
1202 transferstart_info
.done
= 0;
1205 * step1 determine what called us
1206 * step2 determine where to get it
1207 * Look for any request of which we where not yet aware
1209 while (((UFSHCIMem
.CMDUICCMDR
> 0x00) |
1210 ((UFSHCIMem
.TMUTMRLDBR
^ taskCommandTrack
) > 0x00) |
1211 ((UFSHCIMem
.TRUTRLDBR
^ transferTrack
) > 0x00)) ) {
1213 if (UFSHCIMem
.CMDUICCMDR
> 0x00) {
1215 * Command; general control of the Host controller.
1216 * no DMA transfer needed
1219 UFSHCIMem
.ORInterruptStatus
|= UICCommandCOMPL
;
1220 generateInterrupt();
1221 UFSHCIMem
.CMDUICCMDR
= 0x00;
1222 return; //command, nothing more we can do
1224 } else if ((UFSHCIMem
.TMUTMRLDBR
^ taskCommandTrack
) > 0x00) {
1226 * Task; flow control, meant for the device/Logic unit
1227 * DMA transfer is needed, flash will not be approached
1229 size
= sizeof(UTPUPIUTaskReq
);
1230 /**Find the position that is not handled yet*/
1231 count
= findLsbSet((UFSHCIMem
.TMUTMRLDBR
^ taskCommandTrack
));
1232 address
= UFSHCIMem
.TMUTMRLBAU
;
1234 address
= (count
* size
) + (address
<< 32) +
1235 UFSHCIMem
.TMUTMRLBA
;
1236 taskCommandTrack
|= mask
<< count
;
1238 inform("UFSmodel received a task from the system; this might"
1239 " lead to untested behaviour.\n");
1241 task_info
.mask
= mask
<< count
;
1242 task_info
.address
= address
;
1243 task_info
.size
= size
;
1244 task_info
.done
= UFSHCIMem
.TMUTMRLDBR
;
1245 taskInfo
.push_back(task_info
);
1246 taskEventQueue
.push_back(
1247 EventFunctionWrapper([this]{ taskStart(); }, name()));
1248 writeDevice(&taskEventQueue
.back(), false, address
, size
,
1249 reinterpret_cast<uint8_t*>
1250 (&taskInfo
.back().destination
), 0, 0);
1252 } else if ((UFSHCIMem
.TRUTRLDBR
^ transferTrack
) > 0x00) {
1254 * Transfer; Data transfer from or to the disk. There will be DMA
1255 * transfers, and the flash might be approached. Further
1256 * commands, are needed to specify the exact command.
1258 size
= sizeof(UTPTransferReqDesc
);
1259 /**Find the position that is not handled yet*/
1260 count
= findLsbSet((UFSHCIMem
.TRUTRLDBR
^ transferTrack
));
1261 address
= UFSHCIMem
.TRUTRLBAU
;
1263 address
= (count
* size
) + (address
<< 32) + UFSHCIMem
.TRUTRLBA
;
1265 transferTrack
|= mask
<< count
;
1266 DPRINTF(UFSHostDevice
, "Doorbell register: 0x%8x select #:"
1267 " 0x%8x completion info: 0x%8x\n", UFSHCIMem
.TRUTRLDBR
,
1268 count
, transferstart_info
.done
);
1270 transferstart_info
.done
= UFSHCIMem
.TRUTRLDBR
;
1273 transactionStart
[count
] = curTick(); //note the start time
1275 stats
.maxDoorbell
= (stats
.maxDoorbell
.value() < activeDoorbells
)
1276 ? activeDoorbells
: stats
.maxDoorbell
.value();
1277 stats
.averageDoorbell
= stats
.maxDoorbell
.value();
1280 * step3 start transfer
1281 * step4 register information; allowing the host to respond in
1284 transferstart_info
.mask
= mask
<< count
;
1285 transferstart_info
.address
= address
;
1286 transferstart_info
.size
= size
;
1287 transferstart_info
.done
= UFSHCIMem
.TRUTRLDBR
;
1288 transferStartInfo
.push_back(transferstart_info
);
1290 /**Deleted in readDone, queued in finalUTP*/
1291 transferStartInfo
.back().destination
= new struct
1293 DPRINTF(UFSHostDevice
, "Initial transfer start: 0x%8x\n",
1294 transferstart_info
.done
);
1295 transferEventQueue
.push_back(
1296 EventFunctionWrapper([this]{ transferStart(); }, name()));
1298 if (transferEventQueue
.size() < 2) {
1299 writeDevice(&transferEventQueue
.front(), false,
1300 address
, size
, reinterpret_cast<uint8_t*>
1301 (transferStartInfo
.front().destination
),0, 0);
1302 DPRINTF(UFSHostDevice
, "Transfer scheduled\n");
1313 UFSHostDevice::taskStart()
1315 DPRINTF(UFSHostDevice
, "Task start");
1316 taskHandler(&taskInfo
.front().destination
, taskInfo
.front().mask
,
1317 taskInfo
.front().address
, taskInfo
.front().size
);
1318 taskInfo
.pop_front();
1319 taskEventQueue
.pop_front();
1323 * Transfer start event
1327 UFSHostDevice::transferStart()
1329 DPRINTF(UFSHostDevice
, "Enter transfer event\n");
1330 transferHandler(transferStartInfo
.front().destination
,
1331 transferStartInfo
.front().mask
,
1332 transferStartInfo
.front().address
,
1333 transferStartInfo
.front().size
,
1334 transferStartInfo
.front().done
);
1336 transferStartInfo
.pop_front();
1337 DPRINTF(UFSHostDevice
, "Transfer queue size at end of event: "
1338 "0x%8x\n", transferEventQueue
.size());
1342 * Handles the commands that are given. At this point in time, not many
1343 * commands have been implemented in the driver.
1347 UFSHostDevice::commandHandler()
1349 if (UFSHCIMem
.CMDUICCMDR
== 0x16) {
1350 UFSHCIMem
.ORHostControllerStatus
|= 0x0F;//link startup
1356 * Handles the tasks that are given. At this point in time, not many tasks
1357 * have been implemented in the driver.
1361 UFSHostDevice::taskHandler(struct UTPUPIUTaskReq
* request_in
,
1362 uint32_t req_pos
, Addr finaladdress
, uint32_t
1366 * For now, just unpack and acknowledge the task without doing anything.
1367 * TODO Implement UFS tasks.
1369 inform("taskHandler\n");
1370 inform("%8x\n", request_in
->header
.dWord0
);
1371 inform("%8x\n", request_in
->header
.dWord1
);
1372 inform("%8x\n", request_in
->header
.dWord2
);
1374 request_in
->header
.dWord2
&= 0xffffff00;
1376 UFSHCIMem
.TMUTMRLDBR
&= ~(req_pos
);
1377 taskCommandTrack
&= ~(req_pos
);
1378 UFSHCIMem
.ORInterruptStatus
|= UTPTaskREQCOMPL
;
1380 readDevice(true, finaladdress
, finalsize
, reinterpret_cast<uint8_t*>
1381 (request_in
), true, NULL
);
1386 * Obtains the SCSI command (if any)
1387 * Two possibilities: if it contains a SCSI command, then it is a usable
1388 * message; if it doesnt contain a SCSI message, then it can't be handeld
1390 * This is the second stage of the transfer. We have the information about
1391 * where the next command can be found and what the type of command is. The
1392 * actions that are needed from the device its side are: get the information
1393 * and store the information such that we can reply.
1397 UFSHostDevice::transferHandler(struct UTPTransferReqDesc
* request_in
,
1398 int req_pos
, Addr finaladdress
, uint32_t
1399 finalsize
, uint32_t done
)
1402 Addr cmd_desc_addr
= 0x00;
1405 //acknowledge handling of the message
1406 DPRINTF(UFSHostDevice
, "SCSI message detected\n");
1407 request_in
->header
.dWord2
&= 0xffffff00;
1408 SCSIInfo
.RequestIn
= request_in
;
1409 SCSIInfo
.reqPos
= req_pos
;
1410 SCSIInfo
.finalAddress
= finaladdress
;
1411 SCSIInfo
.finalSize
= finalsize
;
1412 SCSIInfo
.destination
.resize(request_in
->PRDTableOffset
* 4
1413 + request_in
->PRDTableLength
* sizeof(UFSHCDSGEntry
));
1414 SCSIInfo
.done
= done
;
1416 assert(!SCSIResumeEvent
.scheduled());
1418 *Get the UTP command that has the SCSI command
1420 cmd_desc_addr
= request_in
->commandDescBaseAddrHi
;
1421 cmd_desc_addr
= (cmd_desc_addr
<< 32) |
1422 (request_in
->commandDescBaseAddrLo
& 0xffffffff);
1424 writeDevice(&SCSIResumeEvent
, false, cmd_desc_addr
,
1425 SCSIInfo
.destination
.size(), &SCSIInfo
.destination
[0],0, 0);
1427 DPRINTF(UFSHostDevice
, "SCSI scheduled\n");
1429 transferEventQueue
.pop_front();
1433 * Obtain LUN and put it in the right LUN queue. Each LUN has its own queue
1434 * of commands that need to be executed. This is the first instance where it
1435 * can be determined which Logic unit should handle the transfer. Then check
1436 * wether it should wait and queue or if it can continue.
1440 UFSHostDevice::SCSIStart()
1442 DPRINTF(UFSHostDevice
, "SCSI message on hold until ready\n");
1443 uint32_t LUN
= SCSIInfo
.destination
[2];
1444 UFSDevice
[LUN
]->SCSIInfoQueue
.push_back(SCSIInfo
);
1446 DPRINTF(UFSHostDevice
, "SCSI queue %d has %d elements\n", LUN
,
1447 UFSDevice
[LUN
]->SCSIInfoQueue
.size());
1449 /**There are 32 doorbells, so at max there can be 32 transactions*/
1450 if (UFSDevice
[LUN
]->SCSIInfoQueue
.size() < 2) //LUN is available
1453 else if (UFSDevice
[LUN
]->SCSIInfoQueue
.size() > 32)
1454 panic("SCSI queue is getting too big %d\n", UFSDevice
[LUN
]->
1455 SCSIInfoQueue
.size());
1458 * First transfer is done, fetch the next;
1459 * At this point, the device is busy, not the HC
1461 if (!transferEventQueue
.empty()) {
1464 * loading next data packet in case Another LUN
1465 * is approached in the mean time
1467 writeDevice(&transferEventQueue
.front(), false,
1468 transferStartInfo
.front().address
,
1469 transferStartInfo
.front().size
, reinterpret_cast<uint8_t*>
1470 (transferStartInfo
.front().destination
), 0, 0);
1472 DPRINTF(UFSHostDevice
, "Transfer scheduled");
1477 * Handles the transfer requests that are given.
1478 * There can be three types of transfer. SCSI specific, Reads and writes
1479 * apart from the data transfer, this also generates its own reply (UPIU
1480 * response). Information for this reply is stored in transferInfo and will
1481 * be used in transferDone
1485 UFSHostDevice::SCSIResume(uint32_t lun_id
)
1487 DPRINTF(UFSHostDevice
, "SCSIresume\n");
1488 if (UFSDevice
[lun_id
]->SCSIInfoQueue
.empty())
1489 panic("No SCSI message scheduled lun:%d Doorbell: 0x%8x", lun_id
,
1490 UFSHCIMem
.TRUTRLDBR
);
1492 /**old info, lets form it such that we can understand it*/
1493 struct UTPTransferReqDesc
* request_in
= UFSDevice
[lun_id
]->
1494 SCSIInfoQueue
.front().RequestIn
;
1496 uint32_t req_pos
= UFSDevice
[lun_id
]->SCSIInfoQueue
.front().reqPos
;
1498 Addr finaladdress
= UFSDevice
[lun_id
]->SCSIInfoQueue
.front().
1501 uint32_t finalsize
= UFSDevice
[lun_id
]->SCSIInfoQueue
.front().finalSize
;
1503 uint32_t* transfercommand
= reinterpret_cast<uint32_t*>
1504 (&(UFSDevice
[lun_id
]->SCSIInfoQueue
.front().destination
[0]));
1506 DPRINTF(UFSHostDevice
, "Task tag: 0x%8x\n", transfercommand
[0]>>24);
1507 /**call logic unit to handle SCSI command*/
1508 request_out_datain
= UFSDevice
[(transfercommand
[0] & 0xFF0000) >> 16]->
1509 SCSICMDHandle(transfercommand
);
1511 DPRINTF(UFSHostDevice
, "LUN: %d\n", request_out_datain
.LUN
);
1514 * build response stating that it was succesful
1515 * command completion, Logic unit number, and Task tag
1517 request_in
->header
.dWord0
= ((request_in
->header
.dWord0
>> 24) == 0x21)
1519 UFSDevice
[lun_id
]->transferInfo
.requestOut
.header
.dWord0
=
1520 request_in
->header
.dWord0
| (request_out_datain
.LUN
<< 8)
1521 | (transfercommand
[0] & 0xFF000000);
1522 /**SCSI status reply*/
1523 UFSDevice
[lun_id
]->transferInfo
.requestOut
.header
.dWord1
= 0x00000000 |
1524 (request_out_datain
.status
<< 24);
1525 /**segment size + EHS length (see UFS standard ch7)*/
1526 UFSDevice
[lun_id
]->transferInfo
.requestOut
.header
.dWord2
= 0x00000000 |
1527 ((request_out_datain
.senseSize
+ 2) << 24) | 0x05;
1528 /**amount of data that will follow*/
1529 UFSDevice
[lun_id
]->transferInfo
.requestOut
.senseDataLen
=
1530 request_out_datain
.senseSize
;
1533 for (uint8_t count
= 0; count
<request_out_datain
.senseSize
; count
++) {
1534 UFSDevice
[lun_id
]->transferInfo
.requestOut
.senseData
[count
] =
1535 request_out_datain
.senseCode
[count
+ 1];
1539 * At position defined by "request_in->PRDTableOffset" (counting 32 bit
1540 * words) in array "transfercommand" we have a scatter gather list, which
1541 * is usefull to us if we interpreted it as a UFSHCDSGEntry structure.
1543 struct UFSHCDSGEntry
* sglist
= reinterpret_cast<UFSHCDSGEntry
*>
1544 (&(transfercommand
[(request_in
->PRDTableOffset
)]));
1546 uint32_t length
= request_in
->PRDTableLength
;
1547 DPRINTF(UFSHostDevice
, "# PRDT entries: %d\n", length
);
1549 Addr response_addr
= request_in
->commandDescBaseAddrHi
;
1550 response_addr
= (response_addr
<< 32) |
1551 ((request_in
->commandDescBaseAddrLo
+
1552 (request_in
->responseUPIULength
<< 2)) & 0xffffffff);
1554 /**transferdone information packet filling*/
1555 UFSDevice
[lun_id
]->transferInfo
.responseStartAddr
= response_addr
;
1556 UFSDevice
[lun_id
]->transferInfo
.reqPos
= req_pos
;
1557 UFSDevice
[lun_id
]->transferInfo
.size
= finalsize
;
1558 UFSDevice
[lun_id
]->transferInfo
.address
= finaladdress
;
1559 UFSDevice
[lun_id
]->transferInfo
.destination
= reinterpret_cast<uint8_t*>
1560 (UFSDevice
[lun_id
]->SCSIInfoQueue
.front().RequestIn
);
1561 UFSDevice
[lun_id
]->transferInfo
.finished
= true;
1562 UFSDevice
[lun_id
]->transferInfo
.lunID
= request_out_datain
.LUN
;
1565 * In this part the data that needs to be transfered will be initiated
1566 * and the chain of DMA (and potentially) disk transactions will be
1569 if (request_out_datain
.expectMore
== 0x01) {
1571 manageWriteTransfer(request_out_datain
.LUN
, request_out_datain
.offset
,
1574 } else if (request_out_datain
.expectMore
== 0x02) {
1576 manageReadTransfer(request_out_datain
.msgSize
, request_out_datain
.LUN
,
1577 request_out_datain
.offset
, length
, sglist
);
1580 /**not disk related transfer, SCSI maintanance*/
1582 uint32_t size_accum
= 0;
1583 DPRINTF(UFSHostDevice
, "Data DMA size: 0x%8x\n",
1584 request_out_datain
.msgSize
);
1586 /**Transport the SCSI reponse data according to the SG list*/
1587 while ((length
> count
) && size_accum
1588 < (request_out_datain
.msgSize
- 1) &&
1589 (request_out_datain
.msgSize
!= 0x00)) {
1590 Addr SCSI_start
= sglist
[count
].upperAddr
;
1591 SCSI_start
= (SCSI_start
<< 32) |
1592 (sglist
[count
].baseAddr
& 0xFFFFFFFF);
1593 DPRINTF(UFSHostDevice
, "Data DMA start: 0x%8x\n", SCSI_start
);
1594 DPRINTF(UFSHostDevice
, "Data DMA size: 0x%8x\n",
1595 (sglist
[count
].size
+ 1));
1597 * safetynet; it has been shown that sg list may be optimistic in
1598 * the amount of data allocated, which can potentially lead to
1599 * some garbage data being send over. Hence this construction
1600 * that finds the least amount of data that needs to be
1603 uint32_t size_to_send
= sglist
[count
].size
+ 1;
1605 if (request_out_datain
.msgSize
< (size_to_send
+ size_accum
))
1606 size_to_send
= request_out_datain
.msgSize
- size_accum
;
1608 readDevice(false, SCSI_start
, size_to_send
,
1609 reinterpret_cast<uint8_t*>
1610 (&(request_out_datain
.message
.dataMsg
[size_accum
])),
1613 size_accum
+= size_to_send
;
1614 DPRINTF(UFSHostDevice
, "Total remaining: 0x%8x,accumulated so far"
1615 " : 0x%8x\n", (request_out_datain
.msgSize
- size_accum
),
1619 DPRINTF(UFSHostDevice
, "Transfer #: %d\n", count
);
1622 /**Go to the next stage of the answering process*/
1623 transferDone(response_addr
, req_pos
, UFSDevice
[lun_id
]->
1624 transferInfo
.requestOut
, finalsize
, finaladdress
,
1625 reinterpret_cast<uint8_t*>(request_in
), true, lun_id
);
1628 DPRINTF(UFSHostDevice
, "SCSI resume done\n");
1632 * Find finished transfer. Callback function. One of the LUNs is done with
1633 * the disk transfer and reports back to the controller. This function finds
1634 * out who it was, and calls transferDone.
1637 UFSHostDevice::LUNSignal()
1639 uint8_t this_lun
= 0;
1641 //while we haven't found the right lun, keep searching
1642 while ((this_lun
< lunAvail
) && !UFSDevice
[this_lun
]->finishedCommand())
1645 if (this_lun
< lunAvail
) {
1647 UFSDevice
[this_lun
]->clearSignal();
1648 //found it; call transferDone
1649 transferDone(UFSDevice
[this_lun
]->transferInfo
.responseStartAddr
,
1650 UFSDevice
[this_lun
]->transferInfo
.reqPos
,
1651 UFSDevice
[this_lun
]->transferInfo
.requestOut
,
1652 UFSDevice
[this_lun
]->transferInfo
.size
,
1653 UFSDevice
[this_lun
]->transferInfo
.address
,
1654 UFSDevice
[this_lun
]->transferInfo
.destination
,
1655 UFSDevice
[this_lun
]->transferInfo
.finished
,
1656 UFSDevice
[this_lun
]->transferInfo
.lunID
);
1660 panic("no LUN finished in tick %d\n", curTick());
1664 * Transfer done. When the data transfer is done, this function ensures
1665 * that the application is notified.
1669 UFSHostDevice::transferDone(Addr responseStartAddr
, uint32_t req_pos
,
1670 struct UTPUPIURSP request_out
, uint32_t size
,
1671 Addr address
, uint8_t* destination
,
1672 bool finished
, uint32_t lun_id
)
1674 /**Test whether SCSI queue hasn't popped prematurely*/
1675 if (UFSDevice
[lun_id
]->SCSIInfoQueue
.empty())
1676 panic("No SCSI message scheduled lun:%d Doorbell: 0x%8x", lun_id
,
1677 UFSHCIMem
.TRUTRLDBR
);
1679 DPRINTF(UFSHostDevice
, "DMA start: 0x%8x; DMA size: 0x%8x\n",
1680 responseStartAddr
, sizeof(request_out
));
1682 struct transferStart lastinfo
;
1683 lastinfo
.mask
= req_pos
;
1684 lastinfo
.done
= finished
;
1685 lastinfo
.address
= address
;
1686 lastinfo
.size
= size
;
1687 lastinfo
.destination
= reinterpret_cast<UTPTransferReqDesc
*>
1689 lastinfo
.lun_id
= lun_id
;
1691 transferEnd
.push_back(lastinfo
);
1693 DPRINTF(UFSHostDevice
, "Transfer done start\n");
1695 readDevice(false, responseStartAddr
, sizeof(request_out
),
1696 reinterpret_cast<uint8_t*>
1697 (&(UFSDevice
[lun_id
]->transferInfo
.requestOut
)),
1702 * finalUTP. Second part of the transfer done event.
1703 * this sends the final response: the UTP response. After this transaction
1704 * the doorbell shall be cleared, and the interupt shall be set.
1708 UFSHostDevice::finalUTP()
1710 uint32_t lun_id
= transferEnd
.front().lun_id
;
1712 UFSDevice
[lun_id
]->SCSIInfoQueue
.pop_front();
1713 DPRINTF(UFSHostDevice
, "SCSIInfoQueue size: %d, lun: %d\n",
1714 UFSDevice
[lun_id
]->SCSIInfoQueue
.size(), lun_id
);
1717 if (UFSHCIMem
.TRUTRLDBR
& transferEnd
.front().mask
) {
1719 while (!(transferEnd
.front().mask
& (0x1 << count
)))
1721 stats
.transactionLatency
.sample(curTick() -
1722 transactionStart
[count
]);
1725 /**Last message that will be transfered*/
1726 readDevice(true, transferEnd
.front().address
,
1727 transferEnd
.front().size
, reinterpret_cast<uint8_t*>
1728 (transferEnd
.front().destination
), true, NULL
);
1730 /**clean and ensure that the tracker is updated*/
1731 transferTrack
&= ~(transferEnd
.front().mask
);
1734 garbage
.push_back(transferEnd
.front().destination
);
1735 transferEnd
.pop_front();
1736 DPRINTF(UFSHostDevice
, "UTP handled\n");
1739 stats
.averageDoorbell
= stats
.maxDoorbell
.value();
1741 DPRINTF(UFSHostDevice
, "activeDoorbells: %d, pendingDoorbells: %d,"
1742 " garbage: %d, TransferEvent: %d\n", activeDoorbells
,
1743 pendingDoorbells
, garbage
.size(), transferEventQueue
.size());
1745 /**This is the moment that the device is available again*/
1746 if (!UFSDevice
[lun_id
]->SCSIInfoQueue
.empty())
1751 * Read done handling function, is only initiated at the end of a transaction
1754 UFSHostDevice::readDone()
1756 DPRINTF(UFSHostDevice
, "Read done start\n");
1759 /**Garbage collection; sort out the allocated UTP descriptor*/
1760 if (garbage
.size() > 0) {
1761 delete garbage
.front();
1762 garbage
.pop_front();
1765 /**done, generate interrupt if we havent got one already*/
1766 if (!(UFSHCIMem
.ORInterruptStatus
& 0x01)) {
1767 UFSHCIMem
.ORInterruptStatus
|= UTPTransferREQCOMPL
;
1768 generateInterrupt();
1772 if (!readDoneEvent
.empty()) {
1773 readDoneEvent
.pop_front();
1778 * set interrupt and sort out the doorbell register.
1782 UFSHostDevice::generateInterrupt()
1784 /**just to keep track of the transactions*/
1787 /**step5 clear doorbell*/
1788 UFSHCIMem
.TRUTRLDBR
&= transferTrack
;
1789 pendingDoorbells
= 0;
1790 DPRINTF(UFSHostDevice
, "Clear doorbell %X\n", UFSHCIMem
.TRUTRLDBR
);
1794 /**step6 raise interrupt*/
1795 gic
->sendInt(intNum
);
1796 DPRINTF(UFSHostDevice
, "Send interrupt @ transaction: 0x%8x!\n",
1805 UFSHostDevice::clearInterrupt()
1807 gic
->clearInt(intNum
);
1808 DPRINTF(UFSHostDevice
, "Clear interrupt: 0x%8x!\n", countInt
);
1812 if (!(UFSHCIMem
.TRUTRLDBR
)) {
1813 idlePhaseStart
= curTick();
1815 /**end of a transaction*/
1819 * Important to understand about the transfer flow:
1820 * We have basically three stages, The "system memory" stage, the "device
1821 * buffer" stage and the "disk" stage. In this model we assume an infinite
1822 * buffer, or a buffer that is big enough to store all the data in the
1823 * biggest transaction. Between the three stages are two queues. Those queues
1824 * store the messages to simulate their transaction from one stage to the
1825 * next. The manage{Action} function fills up one of the queues and triggers
1826 * the first event, which causes a chain reaction of events executed once
1827 * they pass through their queues. For a write action the stages are ordered
1828 * "system memory", "device buffer" and "disk", whereas the read transfers
1829 * happen "disk", "device buffer" and "system memory". The dma action in the
1830 * dma device is written from a bus perspective whereas this model is written
1831 * from a device perspective. To avoid confusion, the translation between the
1832 * two has been made in the writeDevice and readDevice funtions.
1837 * Dma transaction function: write device. Note that the dma action is
1838 * from a device perspective, while this function is from an initiator
1843 UFSHostDevice::writeDevice(Event
* additional_action
, bool toDisk
, Addr
1844 start
, int size
, uint8_t* destination
, uint64_t
1845 SCSIDiskOffset
, uint32_t lun_id
)
1847 DPRINTF(UFSHostDevice
, "Write transaction Start: 0x%8x; Size: %d\n",
1850 /**check whether transfer is all the way to the flash*/
1854 while (!writeDoneEvent
.empty() && (writeDoneEvent
.front().when()
1856 writeDoneEvent
.pop_front();
1858 writeDoneEvent
.push_back(
1859 EventFunctionWrapper([this]{ writeDone(); },
1861 assert(!writeDoneEvent
.back().scheduled());
1863 /**destination is an offset here since we are writing to a disk*/
1864 struct transferInfo new_transfer
;
1865 new_transfer
.offset
= SCSIDiskOffset
;
1866 new_transfer
.size
= size
;
1867 new_transfer
.lunID
= lun_id
;
1868 new_transfer
.filePointer
= 0;
1869 SSDWriteinfo
.push_back(new_transfer
);
1871 /**allocate appropriate buffer*/
1872 SSDWriteinfo
.back().buffer
.resize(size
);
1875 dmaPort
.dmaAction(MemCmd::ReadReq
, start
, size
,
1876 &writeDoneEvent
.back(),
1877 &SSDWriteinfo
.back().buffer
[0], 0);
1878 //yes, a readreq at a write device function is correct.
1879 DPRINTF(UFSHostDevice
, "Write to disk scheduled\n");
1882 assert(!additional_action
->scheduled());
1883 dmaPort
.dmaAction(MemCmd::ReadReq
, start
, size
,
1884 additional_action
, destination
, 0);
1885 DPRINTF(UFSHostDevice
, "Write scheduled\n");
1890 * Manage write transfer. Manages correct transfer flow and makes sure that
1891 * the queues are filled on time
1895 UFSHostDevice::manageWriteTransfer(uint8_t LUN
, uint64_t offset
, uint32_t
1896 sg_table_length
, struct UFSHCDSGEntry
*
1899 struct writeToDiskBurst next_packet
;
1901 next_packet
.SCSIDiskOffset
= offset
;
1903 UFSDevice
[LUN
]->setTotalWrite(sg_table_length
);
1906 * Break-up the transactions into actions defined by the scatter gather
1909 for (uint32_t count
= 0; count
< sg_table_length
; count
++) {
1910 next_packet
.start
= sglist
[count
].upperAddr
;
1911 next_packet
.start
= (next_packet
.start
<< 32) |
1912 (sglist
[count
].baseAddr
& 0xFFFFFFFF);
1913 next_packet
.LUN
= LUN
;
1914 DPRINTF(UFSHostDevice
, "Write data DMA start: 0x%8x\n",
1916 DPRINTF(UFSHostDevice
, "Write data DMA size: 0x%8x\n",
1917 (sglist
[count
].size
+ 1));
1918 assert(sglist
[count
].size
> 0);
1921 next_packet
.SCSIDiskOffset
= next_packet
.SCSIDiskOffset
+
1922 (sglist
[count
- 1].size
+ 1);
1924 next_packet
.size
= sglist
[count
].size
+ 1;
1926 /**If the queue is empty, the transaction should be initiated*/
1927 if (dmaWriteInfo
.empty())
1928 writeDevice(NULL
, true, next_packet
.start
, next_packet
.size
,
1929 NULL
, next_packet
.SCSIDiskOffset
, next_packet
.LUN
);
1931 DPRINTF(UFSHostDevice
, "Write not initiated queue: %d\n",
1932 dmaWriteInfo
.size());
1934 dmaWriteInfo
.push_back(next_packet
);
1935 DPRINTF(UFSHostDevice
, "Write Location: 0x%8x\n",
1936 next_packet
.SCSIDiskOffset
);
1938 DPRINTF(UFSHostDevice
, "Write transfer #: 0x%8x\n", count
+ 1);
1941 stats
.totalWrittenSSD
+= (sglist
[count
].size
+ 1);
1945 ++stats
.totalWriteUFSTransactions
;
1949 * Write done handling function. Is only initiated when the flash is directly
1954 UFSHostDevice::writeDone()
1956 /**DMA is done, information no longer needed*/
1957 assert(dmaWriteInfo
.size() > 0);
1958 dmaWriteInfo
.pop_front();
1959 assert(SSDWriteinfo
.size() > 0);
1960 uint32_t lun
= SSDWriteinfo
.front().lunID
;
1962 /**If there is nothing on the way, we need to start the events*/
1963 DPRINTF(UFSHostDevice
, "Write done entered, queue: %d\n",
1964 UFSDevice
[lun
]->SSDWriteDoneInfo
.size());
1966 UFSDevice
[lun
]->writeFlash(&SSDWriteinfo
.front().buffer
[0],
1967 SSDWriteinfo
.front().offset
,
1968 SSDWriteinfo
.front().size
);
1971 * Move to the second queue, enter the logic unit
1972 * This is where the disk is approached and the flash transaction is
1973 * handled SSDWriteDone will take care of the timing
1975 UFSDevice
[lun
]->SSDWriteDoneInfo
.push_back(SSDWriteinfo
.front());
1976 SSDWriteinfo
.pop_front();
1979 /**so far, only the DMA part has been handled, lets do the disk delay*/
1980 UFSDevice
[lun
]->SSDWriteStart();
1983 stats
.currentWriteSSDQueue
= UFSDevice
[lun
]->SSDWriteDoneInfo
.size();
1984 stats
.averageWriteSSDQueue
= UFSDevice
[lun
]->SSDWriteDoneInfo
.size();
1985 ++stats
.totalWriteDiskTransactions
;
1987 /**initiate the next dma action (if any)*/
1988 if (!dmaWriteInfo
.empty())
1989 writeDevice(NULL
, true, dmaWriteInfo
.front().start
,
1990 dmaWriteInfo
.front().size
, NULL
,
1991 dmaWriteInfo
.front().SCSIDiskOffset
,
1992 dmaWriteInfo
.front().LUN
);
1993 DPRINTF(UFSHostDevice
, "Write done end\n");
1997 * SSD write start. Starts the write action in the timing model
2000 UFSHostDevice::UFSSCSIDevice::SSDWriteStart()
2002 assert(SSDWriteDoneInfo
.size() > 0);
2003 flashDevice
->writeMemory(
2004 SSDWriteDoneInfo
.front().offset
,
2005 SSDWriteDoneInfo
.front().size
, memWriteCallback
);
2007 SSDWriteDoneInfo
.pop_front();
2009 DPRINTF(UFSHostDevice
, "Write is started; left in queue: %d\n",
2010 SSDWriteDoneInfo
.size());
2019 UFSHostDevice::UFSSCSIDevice::SSDWriteDone()
2021 DPRINTF(UFSHostDevice
, "Write disk, aiming for %d messages, %d so far\n",
2022 totalWrite
, amountOfWriteTransfers
);
2024 //we have done one extra transfer
2025 ++amountOfWriteTransfers
;
2027 /**test whether call was correct*/
2028 assert(totalWrite
>= amountOfWriteTransfers
&& totalWrite
!= 0);
2030 /**are we there yet? (did we do everything)*/
2031 if (totalWrite
== amountOfWriteTransfers
) {
2032 DPRINTF(UFSHostDevice
, "Write transactions finished\n");
2034 amountOfWriteTransfers
= 0;
2044 * Dma transaction function: read device. Notice that the dma action is from
2045 * a device perspective, while this function is from an initiator perspective
2049 UFSHostDevice::readDevice(bool lastTransfer
, Addr start
, uint32_t size
,
2050 uint8_t* destination
, bool no_cache
, Event
*
2053 DPRINTF(UFSHostDevice
, "Read start: 0x%8x; Size: %d, data[0]: 0x%8x\n",
2054 start
, size
, (reinterpret_cast<uint32_t *>(destination
))[0]);
2056 /** check wether interrupt is needed */
2059 readDoneEvent
.push_back(
2060 EventFunctionWrapper([this]{ readDone(); },
2062 assert(!readDoneEvent
.back().scheduled());
2063 dmaPort
.dmaAction(MemCmd::WriteReq
, start
, size
,
2064 &readDoneEvent
.back(), destination
, 0);
2065 //yes, a writereq at a read device function is correct.
2068 if (additional_action
!= NULL
)
2069 assert(!additional_action
->scheduled());
2071 dmaPort
.dmaAction(MemCmd::WriteReq
, start
, size
,
2072 additional_action
, destination
, 0);
2079 * Manage read transfer. Manages correct transfer flow and makes sure that
2080 * the queues are filled on time
2084 UFSHostDevice::manageReadTransfer(uint32_t size
, uint32_t LUN
, uint64_t
2085 offset
, uint32_t sg_table_length
,
2086 struct UFSHCDSGEntry
* sglist
)
2088 uint32_t size_accum
= 0;
2090 DPRINTF(UFSHostDevice
, "Data READ size: %d\n", size
);
2093 * Break-up the transactions into actions defined by the scatter gather
2096 for (uint32_t count
= 0; count
< sg_table_length
; count
++) {
2097 struct transferInfo new_transfer
;
2098 new_transfer
.offset
= sglist
[count
].upperAddr
;
2099 new_transfer
.offset
= (new_transfer
.offset
<< 32) |
2100 (sglist
[count
].baseAddr
& 0xFFFFFFFF);
2101 new_transfer
.filePointer
= offset
+ size_accum
;
2102 new_transfer
.size
= (sglist
[count
].size
+ 1);
2103 new_transfer
.lunID
= LUN
;
2105 DPRINTF(UFSHostDevice
, "Data READ start: 0x%8x; size: %d\n",
2106 new_transfer
.offset
, new_transfer
.size
);
2108 UFSDevice
[LUN
]->SSDReadInfo
.push_back(new_transfer
);
2109 UFSDevice
[LUN
]->SSDReadInfo
.back().buffer
.resize(sglist
[count
].size
2113 * The disk image is read here; but the action is simultated later
2114 * You can see this as the preparation stage, whereas later is the
2117 UFSDevice
[LUN
]->readFlash(&UFSDevice
[LUN
]->
2118 SSDReadInfo
.back().buffer
[0],
2119 offset
+ size_accum
,
2120 sglist
[count
].size
+ 1);
2122 size_accum
+= (sglist
[count
].size
+ 1);
2124 DPRINTF(UFSHostDevice
, "Transfer %d; Remaining: 0x%8x, Accumulated:"
2125 " 0x%8x\n", (count
+ 1), (size
-size_accum
), size_accum
);
2128 stats
.totalReadSSD
+= (sglist
[count
].size
+ 1);
2129 stats
.currentReadSSDQueue
= UFSDevice
[LUN
]->SSDReadInfo
.size();
2130 stats
.averageReadSSDQueue
= UFSDevice
[LUN
]->SSDReadInfo
.size();
2133 UFSDevice
[LUN
]->SSDReadStart(sg_table_length
);
2136 ++stats
.totalReadUFSTransactions
;
2143 * SSDisk start read; this function was created to keep the interfaces
2144 * between the layers simpler. Without this function UFSHost would need to
2145 * know about the flashdevice.
2149 UFSHostDevice::UFSSCSIDevice::SSDReadStart(uint32_t total_read
)
2151 totalRead
= total_read
;
2152 for (uint32_t number_handled
= 0; number_handled
< SSDReadInfo
.size();
2155 * Load all the read request to the Memory device.
2156 * It will call back when done.
2158 flashDevice
->readMemory(SSDReadInfo
.front().filePointer
,
2159 SSDReadInfo
.front().size
, memReadCallback
);
2170 UFSHostDevice::UFSSCSIDevice::SSDReadDone()
2172 DPRINTF(UFSHostDevice
, "SSD read done at lun %d, Aiming for %d messages,"
2173 " %d so far\n", lunID
, totalRead
, amountOfReadTransfers
);
2175 if (totalRead
== amountOfReadTransfers
) {
2177 amountOfReadTransfers
= 0;
2179 /**Callback: transferdone*/
2187 * Read callback, on the way from the disk to the DMA. Called by the flash
2188 * layer. Intermediate step to the host layer
2191 UFSHostDevice::UFSSCSIDevice::readCallback()
2193 ++amountOfReadTransfers
;
2195 /**Callback; make sure data is transfered upstream:
2196 * UFSHostDevice::readCallback
2199 deviceReadCallback();
2206 * Read callback, on the way from the disk to the DMA. Called by the UFSSCSI
2211 UFSHostDevice::readCallback()
2213 DPRINTF(UFSHostDevice
, "Read Callback\n");
2214 uint8_t this_lun
= 0;
2216 //while we haven't found the right lun, keep searching
2217 while ((this_lun
< lunAvail
) && !UFSDevice
[this_lun
]->finishedRead())
2220 DPRINTF(UFSHostDevice
, "Found LUN %d messages pending for clean: %d\n",
2221 this_lun
, SSDReadPending
.size());
2223 if (this_lun
< lunAvail
) {
2225 UFSDevice
[this_lun
]->clearReadSignal();
2226 SSDReadPending
.push_back(UFSDevice
[this_lun
]->SSDReadInfo
.front());
2227 UFSDevice
[this_lun
]->SSDReadInfo
.pop_front();
2228 readGarbageEventQueue
.push_back(
2229 EventFunctionWrapper([this]{ readGarbage(); }, name()));
2231 //make sure the queue is popped a the end of the dma transaction
2232 readDevice(false, SSDReadPending
.front().offset
,
2233 SSDReadPending
.front().size
,
2234 &SSDReadPending
.front().buffer
[0], false,
2235 &readGarbageEventQueue
.back());
2238 ++stats
.totalReadDiskTransactions
;
2241 panic("no read finished in tick %d\n", curTick());
2245 * After a disk read DMA transfer, the structure needs to be freed. This is
2246 * done in this function.
2249 UFSHostDevice::readGarbage()
2251 DPRINTF(UFSHostDevice
, "Clean read data, %d\n", SSDReadPending
.size());
2252 SSDReadPending
.pop_front();
2253 readGarbageEventQueue
.pop_front();
2257 * Serialize; needed to make checkpoints
2261 UFSHostDevice::serialize(CheckpointOut
&cp
) const
2263 DmaDevice::serialize(cp
);
2265 const uint8_t* temp_HCI_mem
= reinterpret_cast<const uint8_t*>(&UFSHCIMem
);
2266 SERIALIZE_ARRAY(temp_HCI_mem
, sizeof(HCIMem
));
2268 uint32_t lun_avail
= lunAvail
;
2269 SERIALIZE_SCALAR(lun_avail
);
2274 * Unserialize; needed to restore from checkpoints
2278 UFSHostDevice::unserialize(CheckpointIn
&cp
)
2280 DmaDevice::unserialize(cp
);
2281 uint8_t* temp_HCI_mem
= reinterpret_cast<uint8_t*>(&UFSHCIMem
);
2282 UNSERIALIZE_ARRAY(temp_HCI_mem
, sizeof(HCIMem
));
2285 UNSERIALIZE_SCALAR(lun_avail
);
2286 assert(lunAvail
== lun_avail
);
2291 * Drain; needed to enable checkpoints
2295 UFSHostDevice::drain()
2297 if (UFSHCIMem
.TRUTRLDBR
) {
2298 DPRINTF(UFSHostDevice
, "UFSDevice is draining...\n");
2299 return DrainState::Draining
;
2301 DPRINTF(UFSHostDevice
, "UFSDevice drained\n");
2302 return DrainState::Drained
;
2307 * Checkdrain; needed to enable checkpoints
2311 UFSHostDevice::checkDrain()
2313 if (drainState() != DrainState::Draining
)
2316 if (UFSHCIMem
.TRUTRLDBR
) {
2317 DPRINTF(UFSHostDevice
, "UFSDevice is still draining; with %d active"
2318 " doorbells\n", activeDoorbells
);
2320 DPRINTF(UFSHostDevice
, "UFSDevice is done draining\n");