1/*
2 * Copyright (c) 2013-2015 ARM Limited
3 * All rights reserved
4 *
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.
13 *
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.
24 *
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.
36 *
37 * Authors: Rene de Jong
38 */
39
40#ifndef __DEV_ARM_ABSTRACT_NVM_HH__
41#define __DEV_ARM_ABSTRACT_NVM_HH__
42
43#include "base/callback.hh"
44#include "params/AbstractNVM.hh"
45#include "sim/sim_object.hh"
46
47/**
48 * This is an interface between the disk interface (which will handle the disk
49 * data transactions) and the timing model. The timing model only takes care
50 * of calculating the appropriate delay to the disk, and calling back a
51 * function when the action has completed. All the other associated actions
52 * (such as getting data from A to B) should be taken care of by the disk
53 * interface.
54 */
55class AbstractNVM : public SimObject
56{
57
58  public:
59    AbstractNVM(const AbstractNVMParams* p): SimObject(p) {};
60    virtual ~AbstractNVM() {};
61
62    /**
63     * Initialize Memory.
64     * This function is used to set the memory device dimensions to the
65     * dimensions that it controls. For instance, One can imagine that the
66     * memory is one disk, e.g. the /data partition of Android, which means
67     * that the data handling part will have an image of /data. On the other
68     * hand one might want to set up a Raid like configuration, without
69     * wanting to create multiple disk images. In that case one can choose to
70     * devide the image over multiple memory devices in any way he wants
71     * (i.e. higher layers can implement some division based on logical
72     * addresses, or intelligent file system interpretation analysis; to
73     * effectively devide the disk over the devices; enabling object oriented
74     * storage devices).
75     * Moving this function outside of the constructor allows you the
76     * flexibility to make this decision once the image is loaded.
77     *
78     * @param disk_size disksize in sectors; value can be obtained from the
79     * disk image
80     * @param sector_size size of one sector in bytes; value is defined in
81     * disk_image.hh
82     */
83    virtual void initializeMemory(uint64_t disk_size, uint32_t sector_size) =
84        0;
85
86    /**
87     * Access functions
88     * Access function to simulate a read/write access to the memory. Once
89     * the action has completed, the Callback event should be called. Putting
90     * a NULL pointer as callback is valid syntax, and should result in the
91     * simulation of the access, but with no callback to the higher layer.
92     * This may be used to occupy the device, such that next actions will be
93     * delayed. The read/write function will schedule the incoming requests
94     * on a first come first serve basis.
95     *
96     * @param address The logical address to a location in the Non-volatile
97     * memory.
98     * @param amount The amount of data transfered from the NVM in bytes
99     * @param event A pointer to a callback function that will perform the
100     * actions taken by the disk controller on successfull completion of the
101     * data transfer between the disk and the disk controller.
102     */
103    virtual void readMemory(uint64_t address, uint32_t amount,
104                            Callback *event) = 0;
105    virtual void writeMemory(uint64_t address, uint32_t amount,
106                             Callback *event) = 0;
107};
108
109#endif //__DEV_ARM_ABSTRACT_NVM_HH__
110