summaryrefslogtreecommitdiff
path: root/dev/pcidev.cc
blob: c0358cd5afd77df5bb4f2c92e3504a991aca2005 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
/*
 * Copyright (c) 2003 The Regents of The University of Michigan
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/* @file
 * A single PCI device configuration space entry.
 */

#include <list>
#include <sstream>
#include <string>
#include <vector>

#include "base/inifile.hh"
#include "base/misc.hh"
#include "base/str.hh"	// for to_number
#include "base/trace.hh"
#include "dev/pciareg.h"
#include "dev/scsi_ctrl.hh"
#include "dev/pcidev.hh"
#include "dev/pciconfigall.hh"
#include "mem/functional_mem/memory_control.hh"
#include "sim/builder.hh"
#include "sim/param.hh"
#include "sim/universe.hh"
#include "dev/tsunamireg.h"

using namespace std;

PciDev::PciDev(const string &name, MemoryController *mmu, PCIConfigAll *cf,
               PciConfigData *cd, uint32_t bus, uint32_t dev, uint32_t func)
    : FunctionalMemory(name), MMU(mmu), ConfigSpace(cf), ConfigData(cd),
      Bus(bus), Device(dev), Function(func)
{
    // copy the config data from the PciConfigData object
    if (cd) {
        memcpy(config.data, cd->config.data, sizeof(config.data));
        memcpy(BARSize, cd->BARSize, sizeof(BARSize));
        memcpy(BARAddrs, cd->BARAddrs, sizeof(BARAddrs));
    } else
        panic("NULL pointer to configuration data");

    // Setup pointer in config space to point to this entry
    if (cf->devices[dev][func] != NULL)
        panic("Two PCI devices occuping same dev: %#x func: %#x", dev, func);
    else
        cf->devices[dev][func] = this;
}

void
PciDev::ReadConfig(int offset, int size, uint8_t *data)
{
    switch(size) {
      case sizeof(uint32_t):
        memcpy((uint32_t*)data, config.data + offset, sizeof(uint32_t));
        DPRINTF(PCIDEV,
                "read device: %#x function: %#x register: %#x data: %#x\n",
                Device, Function, offset, *(uint32_t*)(config.data + offset));
        break;

      case sizeof(uint16_t):
        memcpy((uint16_t*)data, config.data + offset, sizeof(uint16_t));
        DPRINTF(PCIDEV,
                "read device: %#x function: %#x register: %#x data: %#x\n",
                Device, Function, offset, *(uint16_t*)(config.data + offset));
        break;

      case sizeof(uint8_t):
        memcpy((uint8_t*)data, config.data + offset, sizeof(uint8_t));
        printf("data: %#x\n", *(uint8_t*)(config.data + offset));
        DPRINTF(PCIDEV,
                "read device: %#x function: %#x register: %#x data: %#x\n",
                Device, Function, offset, *(uint8_t*)(config.data + offset));
        break;

      default:
        panic("Invalid Read Size");
    }
}

void
PciDev::WriteConfig(int offset, int size, uint32_t data)
{
    uint32_t barnum;

    union {
        uint8_t byte_value;
        uint16_t half_value;
        uint32_t word_value;
    };
    word_value = data;

    DPRINTF(PCIDEV,
            "write device: %#x function: %#x reg: %#x size: %#x data: %#x\n",
            Device, Function, offset, size, word_value);

    barnum = (offset - PCI0_BASE_ADDR0) >> 2;

    switch (size) {
      case sizeof(uint8_t): // 1-byte access
        switch (offset) {
          case PCI0_INTERRUPT_LINE:
          case PCI_CACHE_LINE_SIZE:
          case PCI_LATENCY_TIMER:
            *(uint8_t *)&config.data[offset] = byte_value;
            break;

          default:
            panic("writing to a read only register");
        }
        break;

      case sizeof(uint16_t): // 2-byte access
        switch (offset) {
          case PCI_COMMAND:
          case PCI_STATUS:
          case PCI_CACHE_LINE_SIZE:
            *(uint16_t *)&config.data[offset] = half_value;
            break;

          default:
            panic("writing to a read only register");
        }
        break;

      case sizeof(uint16_t)+1: // 3-byte access
        panic("invalid access size");

      case sizeof(uint32_t): // 4-byte access
        switch (offset) {
          case PCI0_BASE_ADDR0:
          case PCI0_BASE_ADDR1:
          case PCI0_BASE_ADDR2:
          case PCI0_BASE_ADDR3:
          case PCI0_BASE_ADDR4:
          case PCI0_BASE_ADDR5:
            // Writing 0xffffffff to a BAR tells the card to set the
            // value of the bar
            // to size of memory it needs
            if (word_value == 0xffffffff) {
                // This is I/O Space, bottom two bits are read only
                if (config.data[offset] & 0x1) {
                    *(uint32_t *)&config.data[offset] =
                        ~(BARSize[barnum] - 1) |
                        (config.data[offset] & 0x3);
                } else {
                    // This is memory space, bottom four bits are read only
                    *(uint32_t *)&config.data[offset] =
                        ~(BARSize[barnum] - 1) |
                        (config.data[offset] & 0xF);
                }
            } else {
                // This is I/O Space, bottom two bits are read only
                if(config.data[offset] & 0x1) {
                    *(uint32_t *)&config.data[offset] = (word_value & ~0x3) |
                        (config.data[offset] & 0x3);

                    if (word_value & ~0x1) {
                        Addr base_addr = (word_value & ~0x1) + TSUNAMI_PCI0_IO;
                        Addr base_size = BARSize[barnum]-1;

                        // It's never been set
                        if (BARAddrs[barnum] == 0)
                            MMU->add_child(this,
                                           Range<Addr>(base_addr,
                                                       base_addr + base_size));
                        else
                            MMU->update_child(this,
                                              Range<Addr>(BARAddrs[barnum],
                                                          BARAddrs[barnum] +
                                                          base_size),
                                              Range<Addr>(base_addr,
                                                          base_addr +
                                                          base_size));

                        BARAddrs[barnum] = base_addr;
                    }

                } else {
                    // This is memory space, bottom four bits are read only
                    *(uint32_t *)&config.data[offset] = (word_value & ~0xF) |
                        (config.data[offset] & 0xF);

                    if (word_value & ~0x3) {
                        Addr base_addr = (word_value & ~0x3) +
                            TSUNAMI_PCI0_MEMORY;

                        Addr base_size = BARSize[barnum]-1;

                        // It's never been set
                        if (BARAddrs[barnum] == 0)
                            MMU->add_child(this,
                                           Range<Addr>(base_addr,
                                                       base_addr + base_size));
                        else
                            MMU->update_child(this,
                                              Range<Addr>(BARAddrs[barnum],
                                                          BARAddrs[barnum] +
                                                          base_size),
                                              Range<Addr>(base_addr,
                                                          base_addr +
                                                          base_size));

                        BARAddrs[barnum] = base_addr;
                    }
                 }
            }
            break;

          case PCI0_ROM_BASE_ADDR:
            if (word_value == 0xfffffffe)
                *(uint32_t *)&config.data[offset] = 0xffffffff;
            else
                *(uint32_t *)&config.data[offset] = word_value;
            break;

          case PCI_COMMAND:
            // This could also clear some of the error bits in the Status
            // register. However they should never get set, so lets ignore
            // it for now
            *(uint16_t *)&config.data[offset] = half_value;
            break;

          default:
            panic("writing to a read only register");
        }
        break;
    }
}

void
PciDev::serialize(ostream &os)
{
    SERIALIZE_ARRAY(config.data, 64);
}

void
PciDev::unserialize(Checkpoint *cp, const std::string &section)
{
    UNSERIALIZE_ARRAY(config.data, 64);
}

#ifndef DOXYGEN_SHOULD_SKIP_THIS

BEGIN_DECLARE_SIM_OBJECT_PARAMS(PciConfigData)

    Param<int> VendorID;
    Param<int> DeviceID;
    Param<int> Command;
    Param<int> Status;
    Param<int> Revision;
    Param<int> ProgIF;
    Param<int> SubClassCode;
    Param<int> ClassCode;
    Param<int> CacheLineSize;
    Param<int> LatencyTimer;
    Param<int> HeaderType;
    Param<int> BIST;
    Param<uint32_t> BAR0;
    Param<uint32_t> BAR1;
    Param<uint32_t> BAR2;
    Param<uint32_t> BAR3;
    Param<uint32_t> BAR4;
    Param<uint32_t> BAR5;
    Param<uint32_t> CardbusCIS;
    Param<int> SubsystemVendorID;
    Param<int> SubsystemID;
    Param<uint32_t> ExpansionROM;
    Param<int> InterruptLine;
    Param<int> InterruptPin;
    Param<int> MinimumGrant;
    Param<int> MaximumLatency;
    Param<uint32_t> BAR0Size;
    Param<uint32_t> BAR1Size;
    Param<uint32_t> BAR2Size;
    Param<uint32_t> BAR3Size;
    Param<uint32_t> BAR4Size;
    Param<uint32_t> BAR5Size;

END_DECLARE_SIM_OBJECT_PARAMS(PciConfigData)

BEGIN_INIT_SIM_OBJECT_PARAMS(PciConfigData)

    INIT_PARAM(VendorID, "Vendor ID"),
    INIT_PARAM(DeviceID, "Device ID"),
    INIT_PARAM_DFLT(Command, "Command Register", 0x00),
    INIT_PARAM_DFLT(Status, "Status Register", 0x00),
    INIT_PARAM_DFLT(Revision, "Device Revision", 0x00),
    INIT_PARAM_DFLT(ProgIF, "Programming Interface", 0x00),
    INIT_PARAM(SubClassCode, "Sub-Class Code"),
    INIT_PARAM(ClassCode, "Class Code"),
    INIT_PARAM_DFLT(CacheLineSize, "System Cacheline Size", 0x00),
    INIT_PARAM_DFLT(LatencyTimer, "PCI Latency Timer", 0x00),
    INIT_PARAM_DFLT(HeaderType, "PCI Header Type", 0x00),
    INIT_PARAM_DFLT(BIST, "Built In Self Test", 0x00),
    INIT_PARAM_DFLT(BAR0, "Base Address Register 0", 0x00),
    INIT_PARAM_DFLT(BAR1, "Base Address Register 1", 0x00),
    INIT_PARAM_DFLT(BAR2, "Base Address Register 2", 0x00),
    INIT_PARAM_DFLT(BAR3, "Base Address Register 3", 0x00),
    INIT_PARAM_DFLT(BAR4, "Base Address Register 4", 0x00),
    INIT_PARAM_DFLT(BAR5, "Base Address Register 5", 0x00),
    INIT_PARAM_DFLT(CardbusCIS, "Cardbus Card Information Structure", 0x00),
    INIT_PARAM_DFLT(SubsystemVendorID, "Subsystem Vendor ID", 0x00),
    INIT_PARAM_DFLT(SubsystemID, "Subsystem ID", 0x00),
    INIT_PARAM_DFLT(ExpansionROM, "Expansion ROM Base Address Register", 0x00),
    INIT_PARAM(InterruptLine, "Interrupt Line Register"),
    INIT_PARAM(InterruptPin, "Interrupt Pin Register"),
    INIT_PARAM_DFLT(MinimumGrant, "Minimum Grant", 0x00),
    INIT_PARAM_DFLT(MaximumLatency, "Maximum Latency", 0x00),
    INIT_PARAM_DFLT(BAR0Size, "Base Address Register 0 Size", 0x00),
    INIT_PARAM_DFLT(BAR1Size, "Base Address Register 1 Size", 0x00),
    INIT_PARAM_DFLT(BAR2Size, "Base Address Register 2 Size", 0x00),
    INIT_PARAM_DFLT(BAR3Size, "Base Address Register 3 Size", 0x00),
    INIT_PARAM_DFLT(BAR4Size, "Base Address Register 4 Size", 0x00),
    INIT_PARAM_DFLT(BAR5Size, "Base Address Register 5 Size", 0x00)

END_INIT_SIM_OBJECT_PARAMS(PciConfigData)

CREATE_SIM_OBJECT(PciConfigData)
{
    PciConfigData *data = new PciConfigData(getInstanceName());

    data->config.hdr.vendor = VendorID;
    data->config.hdr.device = DeviceID;
    data->config.hdr.command = Command;
    data->config.hdr.status = Status;
    data->config.hdr.revision = Revision;
    data->config.hdr.progIF = ProgIF;
    data->config.hdr.subClassCode = SubClassCode;
    data->config.hdr.classCode = ClassCode;
    data->config.hdr.cacheLineSize = CacheLineSize;
    data->config.hdr.latencyTimer = LatencyTimer;
    data->config.hdr.headerType = HeaderType;
    data->config.hdr.bist = BIST;

    data->config.hdr.pci0.baseAddr0 = BAR0;
    data->config.hdr.pci0.baseAddr1 = BAR1;
    data->config.hdr.pci0.baseAddr2 = BAR2;
    data->config.hdr.pci0.baseAddr3 = BAR3;
    data->config.hdr.pci0.baseAddr4 = BAR4;
    data->config.hdr.pci0.baseAddr5 = BAR5;
    data->config.hdr.pci0.cardbusCIS = CardbusCIS;
    data->config.hdr.pci0.subsystemVendorID = SubsystemVendorID;
    data->config.hdr.pci0.subsystemID = SubsystemVendorID;
    data->config.hdr.pci0.expansionROM = ExpansionROM;
    data->config.hdr.pci0.interruptLine = InterruptLine;
    data->config.hdr.pci0.interruptPin = InterruptPin;
    data->config.hdr.pci0.minimumGrant = MinimumGrant;
    data->config.hdr.pci0.maximumLatency = MaximumLatency;

    data->BARSize[0] = BAR0Size;
    data->BARSize[1] = BAR1Size;
    data->BARSize[2] = BAR2Size;
    data->BARSize[3] = BAR3Size;
    data->BARSize[4] = BAR4Size;
    data->BARSize[5] = BAR5Size;

    return data;
}

REGISTER_SIM_OBJECT("PciConfigData", PciConfigData)

#endif // DOXYGEN_SHOULD_SKIP_THIS