Skip to content

Commit c11e903

Browse files
quytranpzzquytranpzz
committed
samples: boards: renesas: Add sample for RX LVD driver
Add a simple sample for LVD driver on RSK-RX130-512kb Signed-off-by: Quy Tran <quy.tran.pz@renesas.com>
1 parent 260602b commit c11e903

File tree

6 files changed

+250
-0
lines changed

6 files changed

+250
-0
lines changed

‎samples/boards/renesas/lvd/CMakeLists.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Copyright (c) 2025 Renesas Electronics Corporation
2+
# SPDX-License-Identifier: Apache-2.0
3+
4+
cmake_minimum_required(VERSION 3.20.0)
5+
6+
find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
7+
project(lvd)
8+
9+
FILE(GLOB app_sources src/*.c)
10+
target_sources(app PRIVATE src/main.c)

‎samples/boards/renesas/lvd/README.rst

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
.. zephyr:code-sample:: renesas-lvd
2+
:name: Renesas Low-voltage Detection Sample
3+
4+
Demonstrates monitoring and reacting to voltage levels.
5+
6+
Overview
7+
********
8+
9+
This sample application shows how to use the Renesas Low-voltage Detection (LVD)
10+
driver in Zephyr to monitor supply voltage and indicate status via LEDs.
11+
The app reads the voltage status, handles LVD interrupts, and updates
12+
LEDs based on whether the voltage is above or below a configured threshold.
13+
14+
Features
15+
********
16+
17+
- Reads voltage status from the LVD peripheral.
18+
- Handles LVD interrupts (if enabled in device tree/config).
19+
- Indicates voltage status using two LEDs:
20+
- LED_ABOVE: On when voltage is above threshold.
21+
- LED_BELOW: On when voltage is below threshold.
22+
- Prints status messages to the console.
23+
24+
Hardware Setup
25+
**************
26+
27+
- Ensure that the monitored target pin is supplied with power.
28+
29+
Building and Running
30+
********************
31+
32+
To build and flash the sample on a supported Renesas RX board:
33+
34+
.. zephyr-app-commands::
35+
:zephyr-app: samples/boards/renesas/lvd
36+
:board: rsk_rx130@512kb
37+
:goals: build flash
38+
:compact:
39+
40+
Usage
41+
*****
42+
43+
- On startup, the app prints the configured voltage threshold.
44+
- The app continuously monitors the voltage:
45+
- If voltage is **above** the threshold, LED_ABOVE is turned on, LED_BELOW is off.
46+
- If voltage is **below** the threshold, LED_BELOW is turned on, LED_ABOVE is off.
47+
- If LVD interrupt is enabled, voltage changes will trigger an interrupt and update the
48+
status immediately.
49+
50+
Customization
51+
*************
52+
53+
- You can change the voltage threshold and LVD action via device tree properties.
54+
- LED pins can be reassigned by modifying the ``led0`` and ``led1`` aliases in your
55+
board's DTS.
56+
57+
Example Output
58+
**************
59+
60+
::
61+
62+
===========================================================
63+
LVD Voltage Monitoring Sample Started
64+
Threshold Voltage Level : 384 mV
65+
===========================================================
66+
[LVD Init] Voltage is ABOVE threshold (384 mV)
67+
[LVD] Interrupt: Voltage level crossing detected!
68+
[WARNING] Voltage instability detected! Check power supply.
69+
[LVD] Voltage is BELOW threshold (384 mV)

‎samples/boards/renesas/lvd/boards/rsk_rx130_512kb.overlay

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
/*
2+
* Copyright (c) 2025 Renesas Electronics Corporation
3+
* SPDX-License-Identifier: Apache-2.0
4+
*/
5+
6+
&pinctrl {
7+
lvd1_default: lvd1_default {
8+
group1 {
9+
/* CMPA2 */
10+
psels = <RX_PSEL(RX_PSEL_LVD, 14, 4)>;
11+
renesas,analog-enable;
12+
input-enable;
13+
};
14+
};
15+
};
16+
17+
&lvd1 {
18+
pinctrl-0 = <&lvd1_default>;
19+
pinctrl-names = "default";
20+
lvd-action = <2>;
21+
voltage-level = <384>;
22+
vdet-target = <1>; /* CMPA2 */
23+
lvd-trigger = <2>; /* LVD_TRIGGER_BOTH */
24+
lvd-stabilization = <0>;
25+
status = "okay";
26+
};

‎samples/boards/renesas/lvd/prj.conf

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
CONFIG_LOG=y

‎samples/boards/renesas/lvd/sample.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
sample:
2+
name: Low Voltage Detector (LVD)
3+
tests:
4+
sample.boards.renesas.lvd:
5+
build_only: true
6+
platform_allow:
7+
- rsk_rx130@512kb
8+
tags: lvd

‎samples/boards/renesas/lvd/src/main.c

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
/*
2+
* Copyright (c) 2025 Renesas Electronics Corporation
3+
*
4+
* SPDX-License-Identifier: Apache-2.0
5+
*/
6+
7+
/* Local Includes */
8+
9+
#include <zephyr/sys/util.h>
10+
#include <zephyr/drivers/misc/renesas_rx_lvd/renesas_rx_lvd.h>
11+
#include <zephyr/drivers/gpio.h>
12+
#include <zephyr/devicetree.h>
13+
#include <zephyr/kernel.h>
14+
#include <stdio.h>
15+
#include <stdlib.h>
16+
#include <string.h>
17+
#include <stdbool.h>
18+
19+
/* LVD node & config from Device Tree */
20+
#if DT_HAS_COMPAT_STATUS_OKAY(renesas_rx_lvd)
21+
#define LVD_NODE DT_INST(0, renesas_rx_lvd)
22+
#endif
23+
24+
#define LVD_ACTION DT_PROP(LVD_NODE, lvd_action)
25+
#define VOLTAGE_THRESHOLD DT_PROP(LVD_NODE, voltage_level)
26+
27+
/* GPIO LEDs */
28+
#define LED_BELOW_NODE DT_ALIAS(led0)
29+
#define LED_ABOVE_NODE DT_ALIAS(led1)
30+
31+
static const struct gpio_dt_spec led_below = GPIO_DT_SPEC_GET(LED_BELOW_NODE, gpios);
32+
static const struct gpio_dt_spec led_above = GPIO_DT_SPEC_GET(LED_ABOVE_NODE, gpios);
33+
34+
/* Semaphore for LVD interrupt */
35+
static struct k_sem lvd_sem;
36+
37+
#if LVD_ACTION == 2
38+
#define LVD_INT 1
39+
#else
40+
#define LVD_INT 0
41+
#endif
42+
43+
#if LVD_INT
44+
void user_callback(void *user_data)
45+
{
46+
ARG_UNUSED(user_data);
47+
printk("[LVD] Interrupt: Voltage level crossing detected!\n");
48+
printk("[WARNING] Voltage instability detected! Check power supply.\n");
49+
k_sem_give(&lvd_sem);
50+
}
51+
#endif
52+
53+
/* Handle voltage status: get, print, update LEDs */
54+
static void handle_voltage_status(const struct device *lvd_dev, const char *tag)
55+
{
56+
int ret;
57+
lvd_status_position_t position;
58+
lvd_status_cross_t cross;
59+
60+
ret = renesas_rx_lvd_get_status(lvd_dev, &position, &cross);
61+
if (ret != 0) {
62+
printk("[%s] Error: Failed to get LVD status.\n", tag);
63+
return;
64+
}
65+
66+
switch (position) {
67+
case LVD_STATUS_POSITION_ABOVE:
68+
printk("[%s] Voltage is ABOVE threshold (%d mV)\n", tag, VOLTAGE_THRESHOLD);
69+
gpio_pin_set_dt(&led_above, 1);
70+
gpio_pin_set_dt(&led_below, 0);
71+
break;
72+
case LVD_STATUS_POSITION_BELOW:
73+
printk("[%s] Voltage is BELOW threshold (%d mV)\n", tag, VOLTAGE_THRESHOLD);
74+
gpio_pin_set_dt(&led_below, 1);
75+
gpio_pin_set_dt(&led_above, 0);
76+
break;
77+
default:
78+
printk("[%s] Unknown voltage position\n", tag);
79+
break;
80+
}
81+
82+
ret = renesas_rx_lvd_clear_status(lvd_dev);
83+
if (ret != 0) {
84+
printk("[%s] Warning: Failed to clear LVD status\n", tag);
85+
}
86+
}
87+
88+
int main(void)
89+
{
90+
int ret;
91+
const struct device *const lvd_dev = DEVICE_DT_GET(LVD_NODE);
92+
93+
k_sem_init(&lvd_sem, 0, 1);
94+
95+
if (!device_is_ready(lvd_dev)) {
96+
printk("[LVD] Error: LVD device not ready.\n");
97+
return -EINVAL;
98+
}
99+
100+
#if LVD_INT
101+
ret = renesas_rx_lvd_register_callback(lvd_dev, user_callback, NULL);
102+
if (ret != 0) {
103+
printk("[LVD] Error: Failed to register callback.\n");
104+
return -EINVAL;
105+
}
106+
#endif
107+
108+
if (!gpio_is_ready_dt(&led_below) || !gpio_is_ready_dt(&led_above)) {
109+
printk("[GPIO] Error: LED GPIOs not ready.\n");
110+
return -ENODEV;
111+
}
112+
113+
ret = gpio_pin_configure_dt(&led_below, GPIO_OUTPUT_ACTIVE);
114+
if (ret < 0) {
115+
return ret;
116+
}
117+
118+
ret = gpio_pin_configure_dt(&led_above, GPIO_OUTPUT_ACTIVE);
119+
if (ret < 0) {
120+
return ret;
121+
}
122+
123+
printk("===========================================================\n");
124+
printk("LVD Voltage Monitoring Sample Started\n");
125+
printk("Threshold Voltage Level : %d mV\n", VOLTAGE_THRESHOLD);
126+
printk("===========================================================\n");
127+
128+
handle_voltage_status(lvd_dev, "LVD Init");
129+
130+
while (1) {
131+
k_sem_take(&lvd_sem, K_FOREVER);
132+
handle_voltage_status(lvd_dev, "LVD");
133+
}
134+
135+
return 0;
136+
}

0 commit comments

Comments
 (0)