summaryrefslogtreecommitdiff
path: root/chip/lm4/adc.c
blob: 18f8dbe3a7c3144cc87d269370d23d16d4b08833 (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
/* Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
 * Use of this source code is governed by a BSD-style license that can be
 * found in the LICENSE file.
 */

/* LM4-specific ADC module for Chrome EC */

#include "adc.h"
#include "console.h"
#include "gpio.h"
#include "hooks.h"
#include "lm4_adc.h"
#include "registers.h"
#include "task.h"
#include "timer.h"
#include "uart.h"
#include "util.h"

extern const struct adc_t adc_channels[ADC_CH_COUNT];

static task_id_t task_waiting_on_ss[LM4_ADC_SEQ_COUNT];

/* GPIO port and mask for AINs. */
const uint32_t ain_port[24][2] = {
	{LM4_GPIO_E, (1<<3)},
	{LM4_GPIO_E, (1<<2)},
	{LM4_GPIO_E, (1<<1)},
	{LM4_GPIO_E, (1<<0)},
	{LM4_GPIO_D, (1<<7)},
	{LM4_GPIO_D, (1<<6)},
	{LM4_GPIO_D, (1<<5)},
	{LM4_GPIO_D, (1<<4)},
	{LM4_GPIO_E, (1<<5)},
	{LM4_GPIO_E, (1<<4)},
	{LM4_GPIO_B, (1<<4)},
	{LM4_GPIO_B, (1<<5)},
	{LM4_GPIO_D, (1<<3)},
	{LM4_GPIO_D, (1<<2)},
	{LM4_GPIO_D, (1<<1)},
	{LM4_GPIO_D, (1<<0)},
	{LM4_GPIO_K, (1<<0)},
	{LM4_GPIO_K, (1<<1)},
	{LM4_GPIO_K, (1<<2)},
	{LM4_GPIO_K, (1<<3)},
	{LM4_GPIO_E, (1<<7)},
	{LM4_GPIO_E, (1<<6)},
	{LM4_GPIO_N, (1<<1)},
	{LM4_GPIO_N, (1<<0)},
};


static void configure_gpio(void)
{
	int i;
	volatile uint32_t scratch  __attribute__((unused));

	/* Enable GPIOE module and delay a few clocks */
	LM4_SYSTEM_RCGCGPIO |= 0x0010;
	scratch = LM4_SYSTEM_RCGCGPIO;

	/* Use analog function for AIN */
	for (i = 0; i < ADC_CH_COUNT; ++i) {
		int id = adc_channels[i].channel;
		if (id != LM4_AIN_NONE)
			gpio_set_alternate_function(ain_port[id][0],
						    ain_port[id][1],
						    1);
	}
}


int lm4_adc_flush_and_read(enum lm4_adc_sequencer seq)
{
	/* TODO: right now we have only a single channel so this is
	 * simple.  When we have multiple channels, should we...
	 *
	 * 1) Read them all using a timer interrupt, and then return
	 * the most recent value?  This is lowest-latency for the
	 * caller, but won't return accurate data if read frequently.
	 *
	 * 2) Reserve SS3 for reading a single value, and configure it
	 * on each read?  Needs mutex if we could have multiple
	 * callers; doesn't matter if just used for debugging.
	 *
	 * 3) Both? */
	volatile uint32_t scratch  __attribute__((unused));
	int event;

	/* Empty the FIFO of any previous results */
	while (!(LM4_ADC_SSFSTAT(seq) & 0x100))
		scratch = LM4_ADC_SSFIFO(seq);

	/* TODO: This assumes we don't have multiple tasks accessing
	 * the same sequencer. Add mutex lock if needed. */
	task_waiting_on_ss[seq] = task_get_current();

	/* Clear the interrupt status */
	LM4_ADC_ADCISC |= 0x01 << seq;

	/* Initiate sample sequence */
	LM4_ADC_ADCPSSI |= 0x01 << seq;

	/* Wait for interrupt */
	event = task_wait_event(1000000);
	task_waiting_on_ss[seq] = TASK_ID_INVALID;
	if (event == TASK_EVENT_TIMER)
		return ADC_READ_ERROR;

	/* Read the FIFO and convert to temperature */
	return LM4_ADC_SSFIFO(seq);
}


int lm4_adc_configure(enum lm4_adc_sequencer seq,
		      int ain_id,
		      int ssctl)
{
	volatile uint32_t scratch  __attribute__((unused));
	/* TODO: set up clock using ADCCC register? */
	/* Configure sample sequencer */
	LM4_ADC_ADCACTSS &= ~(0x01 << seq);
	/* Trigger sequencer by processor request */
	LM4_ADC_ADCEMUX = (LM4_ADC_ADCEMUX & ~(0xf << (seq * 4))) | 0x00;
	/* Sample internal temp sensor */
	if (ain_id != LM4_AIN_NONE) {
		LM4_ADC_SSMUX(seq) = ain_id & 0xf;
		LM4_ADC_SSEMUX(seq) = ain_id >> 4;
	}
	else {
		LM4_ADC_SSMUX(seq) = 0x00;
		LM4_ADC_SSEMUX(seq) = 0x00;
	}
	LM4_ADC_SSCTL(seq) = ssctl;
	/* Enable sample sequencer */
	LM4_ADC_ADCACTSS |= 0x01 << seq;

	return EC_SUCCESS;
}


int adc_read_channel(enum adc_channel ch)
{
	const struct adc_t *adc = adc_channels + ch;
	int rv = lm4_adc_flush_and_read(adc->sequencer);

	if (rv == ADC_READ_ERROR)
		return ADC_READ_ERROR;
	return rv * adc->factor_mul / adc->factor_div + adc->shift;
}

/*****************************************************************************/
/* Interrupt handlers */

/* Handles an interrupt on the specified sample sequencer. */
static void handle_interrupt(int ss)
{
	int id = task_waiting_on_ss[ss];

	/* Clear the interrupt status */
	LM4_ADC_ADCISC = (0x1 << ss);

	/* Wake up the task which was waiting on the interrupt, if any */
	if (id != TASK_ID_INVALID)
		task_wake(id);
}


static void ss0_interrupt(void) { handle_interrupt(0); }
static void ss1_interrupt(void) { handle_interrupt(1); }
static void ss2_interrupt(void) { handle_interrupt(2); }
static void ss3_interrupt(void) { handle_interrupt(3); }

DECLARE_IRQ(LM4_IRQ_ADC0_SS0, ss0_interrupt, 2);
DECLARE_IRQ(LM4_IRQ_ADC0_SS1, ss1_interrupt, 2);
DECLARE_IRQ(LM4_IRQ_ADC0_SS2, ss2_interrupt, 2);
DECLARE_IRQ(LM4_IRQ_ADC0_SS3, ss3_interrupt, 2);

/*****************************************************************************/
/* Console commands */

static int command_ectemp(int argc, char **argv)
{
	int t = adc_read_channel(ADC_CH_EC_TEMP);
	uart_printf("EC temperature is %d K = %d C\n", t, t-273);
	return EC_SUCCESS;
}
DECLARE_CONSOLE_COMMAND(ectemp, command_ectemp);


static int command_adc(int argc, char **argv)
{
	int i;

	for (i = 0; i < ADC_CH_COUNT; ++i)
		uart_printf("ADC channel \"%s\" = %d\n",
			     adc_channels[i].name,
			     adc_read_channel(i));

	return EC_SUCCESS;
}
DECLARE_CONSOLE_COMMAND(adc, command_adc);

/*****************************************************************************/
/* Initialization */

static int adc_init(void)
{
	int i;
	const struct adc_t *adc;

        /* Enable ADC0 module and delay a few clocks */
	LM4_SYSTEM_RCGCADC |= 0x01;
	udelay(1);

	/* Configure GPIOs */
	configure_gpio();

	/* Use external voltage references (VREFA+, VREFA-) instead of
	 * VDDA and GNDA. */
	LM4_ADC_ADCCTL = 0x01;

	/* Use internal oscillator */
	LM4_ADC_ADCCC = 0x1;

	/* Enable interrupt */
	LM4_ADC_ADCIM = 0xF;
	task_enable_irq(LM4_IRQ_ADC0_SS0);
	task_enable_irq(LM4_IRQ_ADC0_SS1);
	task_enable_irq(LM4_IRQ_ADC0_SS2);
	task_enable_irq(LM4_IRQ_ADC0_SS3);

	/* Initialize ADC sequencer */
	for (i = 0; i < ADC_CH_COUNT; ++i) {
		adc = adc_channels + i;
		lm4_adc_configure(adc->sequencer, adc->channel, adc->flag);
	}

	return EC_SUCCESS;
}
DECLARE_HOOK(HOOK_INIT, adc_init, HOOK_PRIO_DEFAULT);