summaryrefslogtreecommitdiff
path: root/src/southbridge/intel/common/smbus.c
blob: 99608dc10fe20a3b95bdc8f9134fad322e1fb669 (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
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
/*
 * This file is part of the coreboot project.
 *
 * Copyright (C) 2005 Yinghai Lu <yinghailu@gmail.com>
 * Copyright (C) 2009 coresystems GmbH
 * Copyright (C) 2013 Vladimir Serbinenko
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; version 2 of the License.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 */

#include <arch/io.h>
#include <console/console.h>
#include <device/smbus_def.h>
#include <stdlib.h>
#include "smbus.h"


#if IS_ENABLED(CONFIG_DEBUG_SMBUS)
#define dprintk(args...) printk(BIOS_DEBUG, ##args)
#else
#define dprintk(args...) do {} while (0)
#endif

/* I801 command constants */
#define I801_QUICK		(0 << 2)
#define I801_BYTE		(1 << 2)
#define I801_BYTE_DATA		(2 << 2)
#define I801_WORD_DATA		(3 << 2)
#define I801_BLOCK_DATA		(5 << 2)
#define I801_I2C_BLOCK_DATA	(6 << 2) /* ICH5 and later */

/* I801 Host Control register bits */
#define SMBHSTCNT_INTREN	(1 << 0)
#define SMBHSTCNT_KILL		(1 << 1)
#define SMBHSTCNT_LAST_BYTE	(1 << 5)
#define SMBHSTCNT_START		(1 << 6)
#define SMBHSTCNT_PEC_EN	(1 << 7) /* ICH3 and later */

/* I801 Hosts Status register bits */
#define SMBHSTSTS_BYTE_DONE	(1 << 7)
#define SMBHSTSTS_INUSE_STS	(1 << 6)
#define SMBHSTSTS_SMBALERT_STS	(1 << 5)
#define SMBHSTSTS_FAILED	(1 << 4)
#define SMBHSTSTS_BUS_ERR	(1 << 3)
#define SMBHSTSTS_DEV_ERR	(1 << 2)
#define SMBHSTSTS_INTR		(1 << 1)
#define SMBHSTSTS_HOST_BUSY	(1 << 0)

#define SMBUS_TIMEOUT		(10 * 1000 * 100)
#define SMBUS_BLOCK_MAXLEN 	32

static void smbus_delay(void)
{
	inb(0x80);
}

static int smbus_wait_until_ready(u16 smbus_base)
{
	unsigned int loops = SMBUS_TIMEOUT;
	unsigned char byte;
	do {
		smbus_delay();
		if (--loops == 0)
			break;
		byte = inb(smbus_base + SMBHSTSTAT);
	} while (byte & SMBHSTSTS_HOST_BUSY);
	return loops ? 0 : -1;
}

static int smbus_wait_until_done(u16 smbus_base)
{
	unsigned int loops = SMBUS_TIMEOUT;
	unsigned char byte;
	do {
		smbus_delay();
		if (--loops == 0)
			break;
		byte = inb(smbus_base + SMBHSTSTAT);
	} while ((byte & SMBHSTSTS_HOST_BUSY)
		|| (byte & ~(SMBHSTSTS_INUSE_STS | SMBHSTSTS_HOST_BUSY)) == 0);
	return loops ? 0 : -1;
}

static int smbus_wait_until_active(u16 smbus_base)
{
	unsigned long loops;
	loops = SMBUS_TIMEOUT;
	do {
		unsigned char val;
		smbus_delay();
		val = inb(smbus_base + SMBHSTSTAT);
		if ((val & SMBHSTSTS_HOST_BUSY)) {
			break;
		}
	} while (--loops);
	return loops ? 0 : -1;
}

int do_smbus_read_byte(unsigned int smbus_base, u8 device,
		unsigned int address)
{
	unsigned char status;
	unsigned char byte;

	if (smbus_wait_until_ready(smbus_base) < 0)
		return SMBUS_WAIT_UNTIL_READY_TIMEOUT;
	/* Set up transaction */
	/* Disable interrupts */
	outb(inb(smbus_base + SMBHSTCTL) & ~SMBHSTCNT_INTREN,
		smbus_base + SMBHSTCTL);
	/* Set the device I'm talking to */
	outb(((device & 0x7f) << 1) | 1, smbus_base + SMBXMITADD);
	/* Set the command/address... */
	outb(address & 0xff, smbus_base + SMBHSTCMD);
	/* Set up for a byte data read */
	outb((inb(smbus_base + SMBHSTCTL) & 0xe3) | I801_BYTE_DATA,
	     (smbus_base + SMBHSTCTL));
	/* Clear any lingering errors, so the transaction will run */
	outb(inb(smbus_base + SMBHSTSTAT), smbus_base + SMBHSTSTAT);

	/* Clear the data byte... */
	outb(0, smbus_base + SMBHSTDAT0);

	/* Start the command */
	outb((inb(smbus_base + SMBHSTCTL) | SMBHSTCNT_START),
	     smbus_base + SMBHSTCTL);

	/* poll for it to start */
	if (smbus_wait_until_active(smbus_base) < 0)
		return SMBUS_WAIT_UNTIL_ACTIVE_TIMEOUT;

	/* Poll for transaction completion */
	if (smbus_wait_until_done(smbus_base) < 0)
		return SMBUS_WAIT_UNTIL_DONE_TIMEOUT;

	status = inb(smbus_base + SMBHSTSTAT);

	/* Ignore the "In Use" status... */
	status &= ~(SMBHSTSTS_SMBALERT_STS | SMBHSTSTS_INUSE_STS);

	/* Read results of transaction */
	byte = inb(smbus_base + SMBHSTDAT0);
	if (status != SMBHSTSTS_INTR)
		return SMBUS_ERROR;
	return byte;
}

int do_smbus_write_byte(unsigned int smbus_base, u8 device,
			unsigned int address, unsigned int data)
{
	unsigned char status;

	if (smbus_wait_until_ready(smbus_base) < 0)
		return SMBUS_WAIT_UNTIL_READY_TIMEOUT;

	/* Set up transaction */
	/* Disable interrupts */
	outb(inb(smbus_base + SMBHSTCTL) & ~SMBHSTCNT_INTREN,
		smbus_base + SMBHSTCTL);
	/* Set the device I'm talking to */
	outb(((device & 0x7f) << 1) & ~0x01, smbus_base + SMBXMITADD);
	/* Set the command/address... */
	outb(address & 0xff, smbus_base + SMBHSTCMD);
	/* Set up for a byte data read */
	outb((inb(smbus_base + SMBHSTCTL) & 0xe3) | I801_BYTE_DATA,
	     (smbus_base + SMBHSTCTL));
	/* Clear any lingering errors, so the transaction will run */
	outb(inb(smbus_base + SMBHSTSTAT), smbus_base + SMBHSTSTAT);

	/* Clear the data byte... */
	outb(data, smbus_base + SMBHSTDAT0);

	/* Start the command */
	outb((inb(smbus_base + SMBHSTCTL) | SMBHSTCNT_START),
	     smbus_base + SMBHSTCTL);

	/* poll for it to start */
	if (smbus_wait_until_active(smbus_base) < 0)
		return SMBUS_WAIT_UNTIL_ACTIVE_TIMEOUT;

	/* Poll for transaction completion */
	if (smbus_wait_until_done(smbus_base) < 0)
		return SMBUS_WAIT_UNTIL_DONE_TIMEOUT;

	status = inb(smbus_base + SMBHSTSTAT);

	/* Ignore the "In Use" status... */
	status &= ~(SMBHSTSTS_SMBALERT_STS | SMBHSTSTS_INUSE_STS);

	/* Read results of transaction */
	if (status != SMBHSTSTS_INTR)
		return SMBUS_ERROR;

	return 0;
}

int do_smbus_block_read(unsigned int smbus_base, u8 device, u8 cmd,
			unsigned int max_bytes, u8 *buf)
{
	u8 status;
	int slave_bytes;
	int bytes_read = 0;
	unsigned int loops = SMBUS_TIMEOUT;
	if (smbus_wait_until_ready(smbus_base) < 0)
		return SMBUS_WAIT_UNTIL_READY_TIMEOUT;

	max_bytes = MIN(SMBUS_BLOCK_MAXLEN, max_bytes);

	/* Set up transaction */
	/* Disable interrupts */
	outb(inb(smbus_base + SMBHSTCTL) & ~SMBHSTCNT_INTREN,
		smbus_base + SMBHSTCTL);
	/* Set the device I'm talking to */
	outb(((device & 0x7f) << 1) | 1, smbus_base + SMBXMITADD);
	/* Set the command/address... */
	outb(cmd & 0xff, smbus_base + SMBHSTCMD);
	/* Set up for a block data read */
	outb((inb(smbus_base + SMBHSTCTL) & 0xc3) | I801_BLOCK_DATA,
	     (smbus_base + SMBHSTCTL));
	/* Clear any lingering errors, so the transaction will run */
	outb(inb(smbus_base + SMBHSTSTAT), smbus_base + SMBHSTSTAT);

	/* Reset number of bytes to transfer so we notice later it
	 * was really updated with the transaction. */
	outb(0, smbus_base + SMBHSTDAT0);

	/* Start the command */
	outb((inb(smbus_base + SMBHSTCTL) | SMBHSTCNT_START),
	     smbus_base + SMBHSTCTL);

	/* poll for it to start */
	if (smbus_wait_until_active(smbus_base) < 0)
		return SMBUS_WAIT_UNTIL_ACTIVE_TIMEOUT;

	/* Poll for transaction completion */
	do {
		loops--;
		status = inb(smbus_base + SMBHSTSTAT);
		if (status & (SMBHSTSTS_FAILED | /* FAILED */
				SMBHSTSTS_BUS_ERR | /* BUS ERR */
				SMBHSTSTS_DEV_ERR)) /* DEV ERR */
			return SMBUS_ERROR;

		if (status & SMBHSTSTS_BYTE_DONE) { /* Byte done */

			if (bytes_read < max_bytes) {
				*buf++ = inb(smbus_base + SMBBLKDAT);
				bytes_read++;
			}

			/* Engine internally completes the transaction
			 * and clears HOST_BUSY flag once the byte count
			 * from slave is reached.
			 */
			outb(status, smbus_base + SMBHSTSTAT);
		}
	} while ((status & SMBHSTSTS_HOST_BUSY) && loops);

	/* Post-check we received complete message. */
	slave_bytes = inb(smbus_base + SMBHSTDAT0);

	dprintk("%s: status = %02x, len = %d / %d, loops = %d\n",
		__func__, status, bytes_read, slave_bytes, loops);

	if (bytes_read < slave_bytes)
		return SMBUS_ERROR;

	return bytes_read;
}

int do_smbus_block_write(unsigned int smbus_base, u8 device, u8 cmd,
			const unsigned int bytes, const u8 *buf)
{
	u8 status;
	int bytes_sent = 0;
	unsigned int loops = SMBUS_TIMEOUT;

	if (bytes > SMBUS_BLOCK_MAXLEN)
		return SMBUS_ERROR;

	if (smbus_wait_until_ready(smbus_base) < 0)
		return SMBUS_WAIT_UNTIL_READY_TIMEOUT;

	/* Set up transaction */
	/* Disable interrupts */
	outb(inb(smbus_base + SMBHSTCTL) & ~SMBHSTCNT_INTREN,
		smbus_base + SMBHSTCTL);
	/* Set the device I'm talking to */
	outb(((device & 0x7f) << 1) & ~0x01, smbus_base + SMBXMITADD);
	/* Set the command/address... */
	outb(cmd & 0xff, smbus_base + SMBHSTCMD);
	/* Set up for a block data write */
	outb((inb(smbus_base + SMBHSTCTL) & 0xc3) | I801_BLOCK_DATA,
	     (smbus_base + SMBHSTCTL));
	/* Clear any lingering errors, so the transaction will run */
	outb(inb(smbus_base + SMBHSTSTAT), smbus_base + SMBHSTSTAT);

	/* set number of bytes to transfer */
	outb(bytes, smbus_base + SMBHSTDAT0);

	/* Send first byte from buffer, bytes_sent increments after
	 * hardware acknowledges it.
	 */
	outb(*buf++, smbus_base + SMBBLKDAT);

	/* Start the command */
	outb((inb(smbus_base + SMBHSTCTL) | SMBHSTCNT_START),
	     smbus_base + SMBHSTCTL);

	/* poll for it to start */
	if (smbus_wait_until_active(smbus_base) < 0)
		return SMBUS_WAIT_UNTIL_ACTIVE_TIMEOUT;

	/* Poll for transaction completion */
	do {
		loops--;
		status = inb(smbus_base + SMBHSTSTAT);
		if (status & (SMBHSTSTS_FAILED | /* FAILED */
				SMBHSTSTS_BUS_ERR | /* BUS ERR */
				SMBHSTSTS_DEV_ERR)) /* DEV ERR */
			return SMBUS_ERROR;

		if (status & SMBHSTSTS_BYTE_DONE) {
			bytes_sent++;
			if (bytes_sent < bytes)
				outb(*buf++, smbus_base + SMBBLKDAT);

			/* Engine internally completes the transaction
			 * and clears HOST_BUSY flag once the byte count
			 * has been reached.
			 */
			outb(status, smbus_base + SMBHSTSTAT);
		}
	} while ((status & SMBHSTSTS_HOST_BUSY) && loops);

	dprintk("%s: status = %02x, len = %d / %d, loops = %d\n",
		__func__, status, bytes_sent, bytes, loops);

	if (bytes_sent < bytes)
		return SMBUS_ERROR;

	return bytes_sent;
}

/* Only since ICH5 */
int do_i2c_block_read(unsigned int smbus_base, u8 device,
		unsigned int offset, const unsigned int bytes, u8 *buf)
{
	u8 status;
	int bytes_read = 0;
	unsigned int loops = SMBUS_TIMEOUT;
	if (smbus_wait_until_ready(smbus_base) < 0)
		return SMBUS_WAIT_UNTIL_READY_TIMEOUT;

	/* Set upp transaction */
	/* Disable interrupts */
	outb(inb(smbus_base + SMBHSTCTL) & SMBHSTCNT_INTREN,
		smbus_base + SMBHSTCTL);
	/* Set the device I'm talking to */
	outb((device & 0x7f) << 1, smbus_base + SMBXMITADD);

	/* device offset */
	outb(offset, smbus_base + SMBHSTDAT1);

	/* Set up for a i2c block data read */
	outb((inb(smbus_base + SMBHSTCTL) & 0xc3) | I801_I2C_BLOCK_DATA,
		(smbus_base + SMBHSTCTL));

	/* Clear any lingering errors, so the transaction will run */
	outb(inb(smbus_base + SMBHSTSTAT), smbus_base + SMBHSTSTAT);
	/* Start the command */
	outb((inb(smbus_base + SMBHSTCTL) | SMBHSTCNT_START),
	     smbus_base + SMBHSTCTL);

	/* poll for it to start */
	if (smbus_wait_until_active(smbus_base) < 0)
		return SMBUS_WAIT_UNTIL_ACTIVE_TIMEOUT;

	/* Poll for transaction completion */
	do {
		loops--;
		status = inb(smbus_base + SMBHSTSTAT);
		if (status & (SMBHSTSTS_FAILED | /* FAILED */
				SMBHSTSTS_BUS_ERR | /* BUS ERR */
				SMBHSTSTS_DEV_ERR)) /* DEV ERR */
			return SMBUS_ERROR;

		if (status & SMBHSTSTS_BYTE_DONE) {

			if (bytes_read < bytes) {
				*buf++ = inb(smbus_base + SMBBLKDAT);
				bytes_read++;
			}

			if (bytes_read + 1 >= bytes) {
				/* indicate that next byte is the last one */
				outb(inb(smbus_base + SMBHSTCTL)
					| SMBHSTCNT_LAST_BYTE,
					smbus_base + SMBHSTCTL);
			}

			outb(status, smbus_base + SMBHSTSTAT);
		}
	} while ((status & SMBHSTSTS_HOST_BUSY) && loops);

	dprintk("%s: status = %02x, len = %d / %d, loops = %d\n",
		__func__, status, bytes_read, bytes, loops);

	if (bytes_read < bytes)
		return SMBUS_ERROR;

	return bytes_read;
}