Software APIs
demos.c
1 // Copyright lowRISC contributors (OpenTitan project).
2 // Licensed under the Apache License, Version 2.0, see LICENSE for details.
3 // SPDX-License-Identifier: Apache-2.0
4 
5 #include "sw/device/examples/demos.h"
6 
7 #include <stdbool.h>
8 
14 #include "sw/device/lib/testing/test_framework/check.h"
15 
16 void demo_gpio_startup(dif_gpio_t *gpio) {
17  LOG_INFO("Watch the LEDs!");
18 
19  // Give a LED pattern as startup indicator for 5 seconds.
20  CHECK_DIF_OK(dif_gpio_write_all(gpio, 0x00ff));
21  for (dif_gpio_pin_t i = 0; i < 32; ++i) {
22  busy_spin_micros(5 * 1000); // 5 ms
23  CHECK_DIF_OK(dif_gpio_write(gpio, 8 + (i % 8), (i / 8) % 2));
24  }
25  CHECK_DIF_OK(dif_gpio_write_all(gpio, 0x0000)); // All LEDs off.
26 }
27 
28 /**
29  * Mask for "valid" GPIO bits. The nibble at [11:8] represents switch inputs,
30  * while the bit at [22] represents the FTDI bit (SW strap 0).
31  */
32 static const uint32_t kGpioMask = 0x400f00;
33 
34 /**
35  * Mask for the FTDI bit (SW strap 0) among the GPIO bits.
36  */
37 static const uint32_t kFtdiMask = 0x400000;
38 
39 uint32_t demo_gpio_to_log_echo(dif_gpio_t *gpio, uint32_t prev_gpio_state) {
40  uint32_t gpio_state;
41  CHECK_DIF_OK(dif_gpio_read_all(gpio, &gpio_state));
42  gpio_state &= kGpioMask;
43 
44  uint32_t state_delta = prev_gpio_state ^ gpio_state;
45  for (int bit_idx = 0; bit_idx < 8; ++bit_idx) {
46  bool changed = ((state_delta >> bit_idx) & 0x1) != 0;
47  bool is_currently_set = ((gpio_state >> bit_idx) & 0x1) != 0;
48  if (changed) {
49  LOG_INFO("GPIO switch #%d changed to %d", bit_idx, is_currently_set);
50  }
51  }
52 
53  if ((state_delta & kFtdiMask) != 0) {
54  if ((gpio_state & kFtdiMask) != 0) {
55  LOG_INFO("FTDI control changed. Enable JTAG.");
56  } else {
57  LOG_INFO("FTDI control changed. Enable JTAG.");
58  }
59  }
60 
61  return gpio_state;
62 }
63 
64 void demo_uart_to_uart_and_gpio_echo(dif_uart_t *uart, dif_gpio_t *gpio) {
65  while (true) {
66  size_t chars_available;
67  if (dif_uart_rx_bytes_available(uart, &chars_available) != kDifOk ||
68  chars_available == 0) {
69  break;
70  }
71 
72  uint8_t rcv_char;
73  CHECK_DIF_OK(dif_uart_bytes_receive(uart, 1, &rcv_char, NULL));
74  CHECK_DIF_OK(dif_uart_byte_send_polled(uart, rcv_char));
75  CHECK_DIF_OK(dif_gpio_write_all(gpio, rcv_char));
76  }
77 }