Boot Linux faster!

Check our new training course

Boot Linux faster!

Check our new training course
and Creative Commons CC-BY-SA
lecture and lab materials

Bootlin logo

Elixir Cross Referencer

  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
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
/*
 * Copyright (c) 2017 Jean-Paul Etienne <fractalclone@gmail.com>
 *
 * SPDX-License-Identifier: Apache-2.0
 */

/**
 * @brief UART driver for the SiFive Freedom E310 Processor
 */

#include <kernel.h>
#include <arch/cpu.h>
#include <uart.h>
#include <board.h>

#define RXDATA_EMPTY   (1 << 31)   /* Receive FIFO Empty */
#define RXDATA_MASK    0xFF        /* Receive Data Mask */

#define TXDATA_FULL    (1 << 31)   /* Transmit FIFO Full */

#define TXCTRL_TXEN    (1 << 0)    /* Activate Tx Channel */

#define RXCTRL_RXEN    (1 << 0)    /* Activate Rx Channel */

#define IE_TXWM        (1 << 0)    /* TX Interrupt Enable/Pending */
#define IE_RXWM        (1 << 1)    /* RX Interrupt Enable/Pending */

/*
 * RX/TX Threshold count to generate TX/RX Interrupts.
 * Used by txctrl and rxctrl registers
 */
#define CTRL_CNT(x)    (((x) & 0x07) << 16)

struct uart_fe310_regs_t {
	u32_t tx;
	u32_t rx;
	u32_t txctrl;
	u32_t rxctrl;
	u32_t ie;
	u32_t ip;
	u32_t div;
};

#ifdef CONFIG_UART_INTERRUPT_DRIVEN
typedef void (*irq_cfg_func_t)(void);
#endif

struct uart_fe310_device_config {
	u32_t       port;
	u32_t       sys_clk_freq;
	u32_t       baud_rate;
	u32_t       rxcnt_irq;
	u32_t       txcnt_irq;
#ifdef CONFIG_UART_INTERRUPT_DRIVEN
	irq_cfg_func_t cfg_func;
#endif
};

struct uart_fe310_data {
#ifdef CONFIG_UART_INTERRUPT_DRIVEN
	uart_irq_callback_t callback;
#endif
};

#define DEV_CFG(dev)						\
	((const struct uart_fe310_device_config * const)	\
	 (dev)->config->config_info)
#define DEV_UART(dev)						\
	((struct uart_fe310_regs_t *)(DEV_CFG(dev))->port)
#define DEV_DATA(dev)						\
	((struct uart_fe310_data * const)(dev)->driver_data)

/**
 * @brief Output a character in polled mode.
 *
 * Writes data to tx register if transmitter is not full.
 *
 * @param dev UART device struct
 * @param c Character to send
 *
 * @return Sent character
 */
static unsigned char uart_fe310_poll_out(struct device *dev,
					 unsigned char c)
{
	volatile struct uart_fe310_regs_t *uart = DEV_UART(dev);

	/* Wait while TX FIFO is full */
	while (uart->tx & TXDATA_FULL)
		;

	uart->tx = (int)c;

	return c;
}

/**
 * @brief Poll the device for input.
 *
 * @param dev UART device struct
 * @param c Pointer to character
 *
 * @return 0 if a character arrived, -1 if the input buffer if empty.
 */
static int uart_fe310_poll_in(struct device *dev, unsigned char *c)
{
	volatile struct uart_fe310_regs_t *uart = DEV_UART(dev);
	u32_t val = uart->rx;

	if (val & RXDATA_EMPTY)
		return -1;

	*c = (unsigned char)(val & RXDATA_MASK);

	return 0;
}

#ifdef CONFIG_UART_INTERRUPT_DRIVEN

/**
 * @brief Fill FIFO with data
 *
 * @param dev UART device struct
 * @param tx_data Data to transmit
 * @param size Number of bytes to send
 *
 * @return Number of bytes sent
 */
static int uart_fe310_fifo_fill(struct device *dev,
				const u8_t *tx_data,
				int size)
{
	volatile struct uart_fe310_regs_t *uart = DEV_UART(dev);
	int i;

	for (i = 0; i < size && !(uart->tx & TXDATA_FULL); i++)
		uart->tx = (int)tx_data[i];

	return i;
}

/**
 * @brief Read data from FIFO
 *
 * @param dev UART device struct
 * @param rxData Data container
 * @param size Container size
 *
 * @return Number of bytes read
 */
static int uart_fe310_fifo_read(struct device *dev,
				u8_t *rx_data,
				const int size)
{
	volatile struct uart_fe310_regs_t *uart = DEV_UART(dev);
	int i;
	u32_t val;

	for (i = 0; i < size; i++) {
		val = uart->rx;

		if (val & RXDATA_EMPTY)
			break;

		rx_data[i] = (u8_t)(val & RXDATA_MASK);
	}

	return i;
}

/**
 * @brief Enable TX interrupt in ie register
 *
 * @param dev UART device struct
 *
 * @return N/A
 */
static void uart_fe310_irq_tx_enable(struct device *dev)
{
	volatile struct uart_fe310_regs_t *uart = DEV_UART(dev);

	uart->ie |= IE_TXWM;
}

/**
 * @brief Disable TX interrupt in ie register
 *
 * @param dev UART device struct
 *
 * @return N/A
 */
static void uart_fe310_irq_tx_disable(struct device *dev)
{
	volatile struct uart_fe310_regs_t *uart = DEV_UART(dev);

	uart->ie &= ~IE_TXWM;
}

/**
 * @brief Check if Tx IRQ has been raised
 *
 * @param dev UART device struct
 *
 * @return 1 if an IRQ is ready, 0 otherwise
 */
static int uart_fe310_irq_tx_ready(struct device *dev)
{
	volatile struct uart_fe310_regs_t *uart = DEV_UART(dev);

	return !!(uart->ip & IE_TXWM);
}

/**
 * @brief Check if nothing remains to be transmitted
 *
 * @param dev UART device struct
 *
 * @return 1 if nothing remains to be transmitted, 0 otherwise
 */
static int uart_fe310_irq_tx_complete(struct device *dev)
{
	volatile struct uart_fe310_regs_t *uart = DEV_UART(dev);

	/*
	 * No TX EMTPY flag for this controller,
	 * just check if TX FIFO is not full
	 */
	return !(uart->tx & TXDATA_FULL);
}

/**
 * @brief Enable RX interrupt in ie register
 *
 * @param dev UART device struct
 *
 * @return N/A
 */
static void uart_fe310_irq_rx_enable(struct device *dev)
{
	volatile struct uart_fe310_regs_t *uart = DEV_UART(dev);

	uart->ie |= IE_RXWM;
}

/**
 * @brief Disable RX interrupt in ie register
 *
 * @param dev UART device struct
 *
 * @return N/A
 */
static void uart_fe310_irq_rx_disable(struct device *dev)
{
	volatile struct uart_fe310_regs_t *uart = DEV_UART(dev);

	uart->ie &= ~IE_RXWM;
}

/**
 * @brief Check if Rx IRQ has been raised
 *
 * @param dev UART device struct
 *
 * @return 1 if an IRQ is ready, 0 otherwise
 */
static int uart_fe310_irq_rx_ready(struct device *dev)
{
	volatile struct uart_fe310_regs_t *uart = DEV_UART(dev);

	return !!(uart->ip & IE_RXWM);
}

/* No error interrupt for this controller */
static void uart_fe310_irq_err_enable(struct device *dev)
{
	ARG_UNUSED(dev);
}

static void uart_fe310_irq_err_disable(struct device *dev)
{
	ARG_UNUSED(dev);
}

/**
 * @brief Check if any IRQ is pending
 *
 * @param dev UART device struct
 *
 * @return 1 if an IRQ is pending, 0 otherwise
 */
static int uart_fe310_irq_is_pending(struct device *dev)
{
	volatile struct uart_fe310_regs_t *uart = DEV_UART(dev);

	return !!(uart->ip & (IE_RXWM | IE_TXWM));
}

static int uart_fe310_irq_update(struct device *dev)
{
	return 1;
}

/**
 * @brief Set the callback function pointer for IRQ.
 *
 * @param dev UART device struct
 * @param cb Callback function pointer.
 *
 * @return N/A
 */
static void uart_fe310_irq_callback_set(struct device *dev,
					uart_irq_callback_t cb)
{
	struct uart_fe310_data *data = DEV_DATA(dev);

	data->callback = cb;
}

static void uart_fe310_irq_handler(void *arg)
{
	struct device *dev = (struct device *)arg;
	struct uart_fe310_data *data = DEV_DATA(dev);

	if (data->callback)
		data->callback(dev);
}

#endif /* CONFIG_UART_INTERRUPT_DRIVEN */


static int uart_fe310_init(struct device *dev)
{
	const struct uart_fe310_device_config * const cfg = DEV_CFG(dev);
	volatile struct uart_fe310_regs_t *uart = DEV_UART(dev);

	/* Enable TX and RX channels */
	uart->txctrl = TXCTRL_TXEN | CTRL_CNT(cfg->rxcnt_irq);
	uart->rxctrl = RXCTRL_RXEN | CTRL_CNT(cfg->txcnt_irq);

	/* Set baud rate */
	uart->div = cfg->sys_clk_freq / cfg->baud_rate - 1;

#ifdef CONFIG_UART_INTERRUPT_DRIVEN
	/* Ensure that uart IRQ is disabled initially */
	uart->ie = 0;

	/* Setup IRQ handler */
	cfg->cfg_func();
#endif

	return 0;
}

static const struct uart_driver_api uart_fe310_driver_api = {
	.poll_in          = uart_fe310_poll_in,
	.poll_out         = uart_fe310_poll_out,
	.err_check        = NULL,
#ifdef CONFIG_UART_INTERRUPT_DRIVEN
	.fifo_fill        = uart_fe310_fifo_fill,
	.fifo_read        = uart_fe310_fifo_read,
	.irq_tx_enable    = uart_fe310_irq_tx_enable,
	.irq_tx_disable   = uart_fe310_irq_tx_disable,
	.irq_tx_ready     = uart_fe310_irq_tx_ready,
	.irq_tx_complete  = uart_fe310_irq_tx_complete,
	.irq_rx_enable    = uart_fe310_irq_rx_enable,
	.irq_rx_disable   = uart_fe310_irq_rx_disable,
	.irq_rx_ready     = uart_fe310_irq_rx_ready,
	.irq_err_enable   = uart_fe310_irq_err_enable,
	.irq_err_disable  = uart_fe310_irq_err_disable,
	.irq_is_pending   = uart_fe310_irq_is_pending,
	.irq_update       = uart_fe310_irq_update,
	.irq_callback_set = uart_fe310_irq_callback_set,
#endif
};

#ifdef CONFIG_UART_FE310_PORT_0

static struct uart_fe310_data uart_fe310_data_0;

#ifdef CONFIG_UART_INTERRUPT_DRIVEN
static void uart_fe310_irq_cfg_func_0(void);
#endif

static const struct uart_fe310_device_config uart_fe310_dev_cfg_0 = {
	.port         = FE310_UART_0_BASE_ADDR,
	.sys_clk_freq = uart_fe310_port_0_clk_freq,
	.baud_rate    = CONFIG_UART_FE310_PORT_0_BAUD_RATE,
	.rxcnt_irq    = CONFIG_UART_FE310_PORT_0_RXCNT_IRQ,
	.txcnt_irq    = CONFIG_UART_FE310_PORT_0_TXCNT_IRQ,
#ifdef CONFIG_UART_INTERRUPT_DRIVEN
	.cfg_func     = uart_fe310_irq_cfg_func_0,
#endif
};

DEVICE_AND_API_INIT(uart_fe310_0, CONFIG_UART_FE310_PORT_0_NAME,
		    uart_fe310_init,
		    &uart_fe310_data_0, &uart_fe310_dev_cfg_0,
		    PRE_KERNEL_1, CONFIG_KERNEL_INIT_PRIORITY_DEVICE,
		    (void *)&uart_fe310_driver_api);

#ifdef CONFIG_UART_INTERRUPT_DRIVEN
static void uart_fe310_irq_cfg_func_0(void)
{
	IRQ_CONNECT(FE310_UART_0_IRQ,
		    CONFIG_UART_FE310_PORT_0_IRQ_PRIORITY,
		    uart_fe310_irq_handler, DEVICE_GET(uart_fe310_0),
		    0);

	irq_enable(FE310_UART_0_IRQ);
}
#endif

#endif /* CONFIG_FE310_UART_0 */

#ifdef CONFIG_UART_FE310_PORT_1

static struct uart_fe310_data uart_fe310_data_1;

#ifdef CONFIG_UART_INTERRUPT_DRIVEN
static void uart_fe310_irq_cfg_func_1(void);
#endif

static const struct uart_fe310_device_config uart_fe310_dev_cfg_1 = {
	.port         = FE310_UART_1_BASE_ADDR,
	.sys_clk_freq = uart_fe310_port_1_clk_freq,
	.baud_rate    = CONFIG_UART_FE310_PORT_1_BAUD_RATE,
	.rxcnt_irq    = CONFIG_UART_FE310_PORT_1_RXCNT_IRQ,
	.txcnt_irq    = CONFIG_UART_FE310_PORT_1_TXCNT_IRQ,
#ifdef CONFIG_UART_INTERRUPT_DRIVEN
	.cfg_func     = uart_fe310_irq_cfg_func_1,
#endif
};

DEVICE_AND_API_INIT(uart_fe310_1, CONFIG_UART_FE310_PORT_1_NAME,
		    uart_fe310_init,
		    &uart_fe310_data_1, &uart_fe310_dev_cfg_1,
		    PRE_KERNEL_1, CONFIG_KERNEL_INIT_PRIORITY_DEVICE,
		    (void *)&uart_fe310_driver_api);

#ifdef CONFIG_UART_INTERRUPT_DRIVEN
static void uart_fe310_irq_cfg_func_1(void)
{
	IRQ_CONNECT(FE310_UART_1_IRQ,
		    CONFIG_UART_FE310_PORT_1_IRQ_PRIORITY,
		    uart_fe310_irq_handler, DEVICE_GET(uart_fe310_1),
		    0);

	irq_enable(FE310_UART_1_IRQ);
}
#endif

#endif /* CONFIG_FE310_UART_1 */