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
|
/*
* Copyright (c) 2025 Ian Marco Moffett and L5 engineers
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. 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.
* 3. Neither the name of the project 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.
*/
/*
* Description: AHCI HBA driver
* Author: Ian Marco Moffett
*/
#include <sys/types.h>
#include <sys/syslog.h>
#include <sys/cdefs.h>
#include <sys/errno.h>
#include <io/pci/pci.h>
#include <io/pci/bar.h>
#include <io/ic/ahciregs.h>
#include <io/ic/ahcivar.h>
#include <os/module.h>
#include <os/clkdev.h>
#include <os/mmio.h>
/*
* Represents the PCI advocation descriptor for this
* device so we can advertise ourselves as its driver.
*/
static struct pci_adv driver;
/* Various other state */
static struct pci_device dev;
static struct clkdev *clkdev;
static struct ahci_hba root_hba;
/*
* Poll register to have 'bits' set/unset.
*
* @reg: Register to poll.
* @bits: Bits to be checked.
* @pollset: True to poll as set.
*
* Returns zero if the register updated in time, otherwise a less
* than zero value upon failure.
*/
static int
ahci_poll32(volatile uint32_t *reg, uint32_t bits, bool pollset)
{
size_t usec_start, usec;
size_t elapsed_msec;
uint32_t val;
bool tmp;
usec_start = clkdev->get_time_usec();
for (;;) {
val = mmio_read32(reg);
tmp = (pollset) ? ISSET(val, bits) : !ISSET(val, bits);
usec = clkdev->get_time_usec();
elapsed_msec = (usec - usec_start) / 1000;
/* If tmp is set, the register updated in time */
if (tmp) {
break;
}
/* Exit with an error if we timeout */
if (elapsed_msec > AHCI_TIMEOUT) {
return -ETIME;
}
}
return 0;
}
/*
* Perform a full HBA reset by using the HR bit
* within the GHC register.
*
* See section 10.4.3 of the AHCI spec for more
* information.
*/
static int
ahci_hba_reset(struct ahci_hba *hba)
{
volatile struct hba_memspace *io = hba->io;
uint32_t ghc;
int error;
/* Begin the reset */
ghc = mmio_read32(&io->ghc);
ghc |= AHCI_GHC_HR;
mmio_write32(&io->ghc, ghc);
/* Wait until it is done */
error = ahci_poll32(&io->ghc, AHCI_GHC_HR, false);
if (error < 0) {
printf("ahci: HBA reset timed out\n");
return error;
}
return 0;
}
/*
* Put the HBA as well as its devices in an initialized
* state so that they may be used for operation.
*/
static int
ahci_hba_init(struct ahci_hba *hba)
{
volatile struct hba_memspace *io = hba->io;
uint32_t ghc;
int error;
/* Ensure the host controller is AHCI aware */
ghc = mmio_read32(&io->ghc);
ghc |= AHCI_GHC_AE;
mmio_write32(&io->ghc, ghc);
/*
* We cannot be so certain what state the BIOS or whatever
* firmware left the host controller in, therefore the HBA
* will require a reset so we can have it in a known state.
*/
if ((error = ahci_hba_reset(hba)) < 0) {
return error;
}
return 0;
}
/*
* Initialize only the AHCI driver's state rather than
* the hardware it covers. This is used so we can advertise
* ourself to the PCI driver.
*/
static int
ahci_init(struct module *modp)
{
uint16_t clkmask;
int error;
clkmask = CLKDEV_MSLEEP | CLKDEV_GET_USEC;
error = clkdev_get(clkmask, &clkdev);
if (error < 0) {
printf("ahci_init: could not get clkdev\n");
return error;
}
if ((error = pci_advoc(&driver)) < 0) {
printf("ahci_init: failed to advocate for HBA\n");
return error;
}
root_hba.io = NULL;
return 0;
}
/*
* Ran when a device is attached, does the actual
* hardware initialization.
*/
static int
ahci_attach(struct pci_adv *adv)
{
struct bus_space bs;
int error;
/* Only call once */
if (root_hba.io != NULL) {
return -EIO;
}
dev = adv->lookup;
printf("ahci: detected AHCI controller\n");
/* Map ABAR */
error = pci_map_bar(&dev, 5, &bs);
if (error < 0) {
printf("ahci: failed to map bar 5 (error=%d)\n", error);
return error;
}
root_hba.io = (void *)bs.va_base;
return ahci_hba_init(&root_hba);
}
static struct pci_adv driver = {
.lookup = PCI_CS_ID(0x1, 0x06),
.attach = ahci_attach,
.classrev = 1
};
MODULE_EXPORT("ahci", MODTYPE_PCI, ahci_init);
|
