1# Copyright (c) 2013-2015 ARM Limited
2# All rights reserved.
3#
4# The license below extends only to copyright in the software and shall
5# not be construed as granting a license to any other intellectual
6# property including but not limited to intellectual property relating
7# to a hardware implementation of the functionality of the software
8# licensed hereunder.  You may use the software subject to the license
9# terms below provided that you ensure that this notice is replicated
10# unmodified and in its entirety in all distributions of the software,
11# modified or unmodified, in source code or in binary form.
12#
13# Redistribution and use in source and binary forms, with or without
14# modification, are permitted provided that the following conditions are
15# met: redistributions of source code must retain the above copyright
16# notice, this list of conditions and the following disclaimer;
17# redistributions in binary form must reproduce the above copyright
18# notice, this list of conditions and the following disclaimer in the
19# documentation and/or other materials provided with the distribution;
20# neither the name of the copyright holders nor the names of its
21# contributors may be used to endorse or promote products derived from
22# this software without specific prior written permission.
23#
24# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35#
36# Authors: Rene de Jong
37#
38import sys
39from m5.params import *
40from m5.proxy import *
41from m5.objects.Device import DmaDevice
42from m5.objects.AbstractNVM import *
43
44class UFSHostDevice(DmaDevice):
45    type = 'UFSHostDevice'
46    cxx_header = "dev/arm/ufs_device.hh"
47    pio_addr = Param.Addr("Address for SCSI configuration slave interface")
48    pio_latency = Param.Latency("10ns", "Time between action and write/read \
49       result by AMBA DMA Device")
50    gic = Param.BaseGic(Parent.any, "Gic to use for interrupting")
51    int_num = Param.UInt32("Interrupt number that connects to GIC")
52    img_blk_size = Param.UInt32(512, "Size of one image block in bytes")
53    # Every image that is added to the vector will generate a new logic unit
54    # in the UFS device; Theoretically (when using the driver from Linux
55    # kernel 3.9 onwards), this can be as many as eigth. Up to two have been
56    # tested.
57    image = VectorParam.DiskImage("Disk images")
58    # Every logic unit can have its own flash dimensions. So the number of
59    # images that have been provided in the image vector, should be equal to
60    # the number of flash objects that are created. Each logic unit can have
61    # its own flash dimensions; to allow the system to define a hetrogeneous
62    # storage system.
63    internalflash = VectorParam.AbstractNVM("Describes the internal flash")
64    ufs_slots = Param.UInt32(32, "Number of commands that can be queued in \
65        the Host controller (min: 1, max: 32)")
66
67