mirror of
https://github.com/mytechnotalent/Embedded-Hacking.git
synced 2026-08-09 12:26:11 +02:00
style: enforce coding standard — headers, @brief on #define, Doxygen on statics, remove _ prefix, max 8 lines per function
This commit is contained in:
@@ -1,37 +1,48 @@
|
||||
/**
|
||||
******************************************************************************
|
||||
* @file main.c
|
||||
* @author Kevin Thomas
|
||||
* @brief PWM demonstration: LED breathing effect via duty-cycle sweep.
|
||||
*
|
||||
* Demonstrates PWM output using the PWM driver. A signal on
|
||||
* GPIO 25 (onboard LED) sweeps its duty cycle from 0% to 100%
|
||||
* and back to produce a smooth breathing effect. The current
|
||||
* duty is reported over UART.
|
||||
*
|
||||
* Wiring:
|
||||
* GPIO0 -> UART TX (USB-to-UART adapter RX)
|
||||
* GPIO1 -> UART RX (USB-to-UART adapter TX)
|
||||
* GPIO25 -> Onboard LED (no external wiring needed)
|
||||
*
|
||||
******************************************************************************
|
||||
* @attention
|
||||
*
|
||||
* Copyright (c) 2026 Kevin Thomas.
|
||||
* All rights reserved.
|
||||
*
|
||||
* This software is licensed under terms that can be found in the LICENSE file
|
||||
* in the root directory of this software component.
|
||||
* If no LICENSE file comes with this software, it is provided AS-IS.
|
||||
*
|
||||
******************************************************************************
|
||||
*/
|
||||
|
||||
* @file main.c
|
||||
* @brief PWM demonstration: LED breathing effect via duty-cycle sweep.
|
||||
* @author Kevin Thomas
|
||||
* @date 2026
|
||||
*
|
||||
* Demonstrates PWM output using the PWM driver. A signal on
|
||||
* GPIO 25 (onboard LED) sweeps its duty cycle from 0% to 100%
|
||||
* and back to produce a smooth breathing effect. The current
|
||||
* duty is reported over UART.
|
||||
*
|
||||
* Wiring:
|
||||
* GPIO0 -> UART TX (USB-to-UART adapter RX)
|
||||
* GPIO1 -> UART RX (USB-to-UART adapter TX)
|
||||
* GPIO25 -> Onboard LED (no external wiring needed)
|
||||
*
|
||||
* MIT License
|
||||
*
|
||||
* Copyright (c) 2026 Kevin Thomas
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in all
|
||||
* copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
* SOFTWARE.
|
||||
*/
|
||||
#include "rp2350_pwm.h"
|
||||
#include "rp2350_uart.h"
|
||||
#include "rp2350_delay.h"
|
||||
|
||||
/** @brief PWM duty cycle increment per step */
|
||||
#define SWEEP_STEP 5
|
||||
/** @brief Delay between PWM sweep steps in milliseconds */
|
||||
#define SWEEP_DELAY_MS 50
|
||||
|
||||
/**
|
||||
@@ -40,7 +51,7 @@
|
||||
* @param buf output buffer (at least 4 bytes)
|
||||
* @retval None
|
||||
*/
|
||||
static void _uint8_to_str(uint8_t value, char *buf)
|
||||
static void uint8_to_str(uint8_t value, char *buf)
|
||||
{
|
||||
uint8_t idx = 0;
|
||||
if (value >= 100)
|
||||
@@ -59,7 +70,7 @@ static void _uint8_to_str(uint8_t value, char *buf)
|
||||
static void print_duty(uint8_t duty)
|
||||
{
|
||||
char buf[4];
|
||||
_uint8_to_str(duty, buf);
|
||||
uint8_to_str(duty, buf);
|
||||
uart_puts("Duty: ");
|
||||
uart_puts(buf);
|
||||
uart_puts("%\r\n");
|
||||
|
||||
Reference in New Issue
Block a user