get rid of @brief
parent
77f2ffc947
commit
67d4d8e8db
2
Doxyfile
2
Doxyfile
|
|
@ -169,7 +169,7 @@ SHORT_NAMES = NO
|
|||
# description.)
|
||||
# The default value is: NO.
|
||||
|
||||
JAVADOC_AUTOBRIEF = NO
|
||||
JAVADOC_AUTOBRIEF = YES
|
||||
|
||||
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
|
||||
# line (until the first dot) of a Qt-style comment as the brief description. If
|
||||
|
|
|
|||
12
global.h
12
global.h
|
|
@ -12,7 +12,7 @@
|
|||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
/** @brief global definitions and methods
|
||||
/** global definitions and methods
|
||||
* @file global.h
|
||||
* @author King Kévin <kingkevin@cuvoodoo.info>
|
||||
* @date 2016
|
||||
|
|
@ -60,7 +60,7 @@
|
|||
#endif
|
||||
/** @} */
|
||||
|
||||
/** @brief switch on board LED */
|
||||
/** switch on board LED */
|
||||
inline void led_on(void)
|
||||
{
|
||||
#if defined(SYSTEM_BOARD) || defined(BLUE_PILL)
|
||||
|
|
@ -69,7 +69,7 @@ inline void led_on(void)
|
|||
gpio_set(LED_PORT, LED_PIN);
|
||||
#endif
|
||||
}
|
||||
/** @brief switch off board LED */
|
||||
/** switch off board LED */
|
||||
inline void led_off(void)
|
||||
{
|
||||
#if defined(SYSTEM_BOARD) || defined(BLUE_PILL)
|
||||
|
|
@ -78,14 +78,14 @@ inline void led_off(void)
|
|||
gpio_clear(LED_PORT, LED_PIN);
|
||||
#endif
|
||||
}
|
||||
/** @brief toggle board LED */
|
||||
/** toggle board LED */
|
||||
inline void led_toggle(void)
|
||||
{
|
||||
gpio_toggle(LED_PORT, LED_PIN);
|
||||
}
|
||||
/** @brief default printf output */
|
||||
/** default printf output */
|
||||
int _write(int file, char *ptr, int len);
|
||||
/** @brief get binary representation of a number
|
||||
/** get binary representation of a number
|
||||
* @param[in] binary number to represent in binary
|
||||
* @param[in] rjust justify representation with leading zeros
|
||||
* @return string with binary representation of the number
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@
|
|||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
/** @brief library to drive a WS2812b LED chain (code)
|
||||
/** library to drive a WS2812b LED chain (code)
|
||||
* @file led_ws2812b.c
|
||||
* @author King Kévin <kingkevin@cuvoodoo.info>
|
||||
* @date 2016
|
||||
|
|
@ -35,7 +35,7 @@
|
|||
#include "led_ws2812b.h" // LED WS2812b library API
|
||||
#include "global.h" // common methods
|
||||
|
||||
/** @brief bit template to encode one byte to be shifted out by SPI to the WS2812b LEDs
|
||||
/** bit template to encode one byte to be shifted out by SPI to the WS2812b LEDs
|
||||
* @details For each WS2812b bit which needs to be transfered we require to transfer 3 SPI bits.
|
||||
* The first SPI bit is the high start of the WS2812b bit frame.
|
||||
* The second SPI bit determines if the WS2812b bit is a 0 or 1.
|
||||
|
|
@ -150,7 +150,7 @@ void led_ws2812b_setup(void)
|
|||
led_ws2812b_transmit(); // set LEDs
|
||||
}
|
||||
|
||||
/** @brief DMA interrupt service routine to stop transmission after it finished */
|
||||
/** DMA interrupt service routine to stop transmission after it finished */
|
||||
void LED_WS2812B_DMA_ISR(void)
|
||||
{
|
||||
if (dma_get_interrupt_flag(LED_WS2812B_DMA, LED_WS2812B_DMA_CH, DMA_TCIF)) { // transfer completed
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@
|
|||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
/** @brief library to drive a WS2812b LED chain (API)
|
||||
/** library to drive a WS2812b LED chain (API)
|
||||
* @file led_ws2812b.h
|
||||
* @author King Kévin <kingkevin@cuvoodoo.info>
|
||||
* @date 2016
|
||||
|
|
@ -55,9 +55,9 @@
|
|||
#define LED_WS2812B_DMA_ISR dma1_channel3_isr /**< DMA channel interrupt service routine */
|
||||
/** @} */
|
||||
|
||||
/** @brief setup WS2812b LED driver */
|
||||
/** setup WS2812b LED driver */
|
||||
void led_ws2812b_setup(void);
|
||||
/** @brief set color of a single LED
|
||||
/** set color of a single LED
|
||||
* @param[in] led the LED number to set the color
|
||||
* @param[in] red the red color value to set on the LED
|
||||
* @param[in] green the green color value to set on the LED
|
||||
|
|
@ -65,7 +65,7 @@ void led_ws2812b_setup(void);
|
|||
* @note transmission needs to be done separately
|
||||
*/
|
||||
void led_ws2812b_set_rgb(uint16_t led, uint8_t red, uint8_t green, uint8_t blue);
|
||||
/** @brief transmit color values to WS2812b LEDs
|
||||
/** transmit color values to WS2812b LEDs
|
||||
* @return true if transmission started, false if another transmission is already ongoing
|
||||
*/
|
||||
bool led_ws2812b_transmit(void);
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@
|
|||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
/** @brief library to get time from a DCF77 module (code)
|
||||
/** library to get time from a DCF77 module (code)
|
||||
* @file rtc_dcf77.c
|
||||
* @author King Kévin <kingkevin@cuvoodoo.info>
|
||||
* @date 2016
|
||||
|
|
@ -120,7 +120,7 @@ uint8_t* rtc_dcf77_time(void)
|
|||
return to_return;
|
||||
}
|
||||
|
||||
/** @brief interrupt service routine called when signal edge is detected, decoding the received DCF77 frame (composed by high pulses) */
|
||||
/** interrupt service routine called when signal edge is detected, decoding the received DCF77 frame (composed by high pulses) */
|
||||
void RTC_DCF77_SIGNAL_ISR(void)
|
||||
{
|
||||
exti_reset_request(RTC_DCF77_SIGNAL_EXTI); // reset interrupt
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@
|
|||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
/** @brief library to get time from a DCF77 module (API)
|
||||
/** library to get time from a DCF77 module (API)
|
||||
* @file rtc_dcf77.h
|
||||
* @author King Kévin <kingkevin@cuvoodoo.info>
|
||||
* @date 2016
|
||||
|
|
@ -42,16 +42,16 @@
|
|||
#define RTC_DCF77_TIMER_MAX_TIME 2200 /**< the maximum time in ms the timer can count. DCF77 have pulses < 2s */
|
||||
/** @} */
|
||||
|
||||
/** @brief set when time information has been received */
|
||||
/** set when time information has been received */
|
||||
extern volatile bool rtc_dcf77_time_flag;
|
||||
|
||||
/** @brief setup DCF77 time receiver module */
|
||||
/** setup DCF77 time receiver module */
|
||||
void rtc_dcf77_setup(void);
|
||||
/** @brief switch on DCF77 time receiver module */
|
||||
/** switch on DCF77 time receiver module */
|
||||
void rtc_dcf77_on(void);
|
||||
/** @brief switch off DCF77 time receiver module */
|
||||
/** switch off DCF77 time receiver module */
|
||||
void rtc_dcf77_off(void);
|
||||
/** @brief get last received DCF77 time
|
||||
/** get last received DCF77 time
|
||||
* @return array of {minutes (00-49), hours (00-23), date (01-31), day of the week (1-7=Monday-Sunday), month (01-12), year of the century (00-99)} if received time is valid, NULL else
|
||||
*/
|
||||
uint8_t* rtc_dcf77_time(void);
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@
|
|||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
/** @brief library to communicate with the Maxim DS1307 I2C RTC IC (code)
|
||||
/** library to communicate with the Maxim DS1307 I2C RTC IC (code)
|
||||
* @file rtc_ds1307.c
|
||||
* @author King Kévin <kingkevin@cuvoodoo.info>
|
||||
* @date 2016
|
||||
|
|
@ -80,7 +80,7 @@ void rtc_ds1307_setup(void)
|
|||
#endif
|
||||
}
|
||||
|
||||
/** @brief read memory from RTC IC
|
||||
/** read memory from RTC IC
|
||||
* @param[in] addr start address for memory to read
|
||||
* @param[out] data buffer to store read memory
|
||||
* @param[in] len number of byte to read from the memory
|
||||
|
|
@ -245,7 +245,7 @@ uint8_t* rtc_ds1307_read_time(void)
|
|||
return time;
|
||||
}
|
||||
|
||||
/** @brief write memory into RTC IC
|
||||
/** write memory into RTC IC
|
||||
* @param[in] addr start address for memory to be written
|
||||
* @param[in] data buffer to for memory to be written
|
||||
* @param[in] len number of byte to write into the memory
|
||||
|
|
@ -444,7 +444,7 @@ bool rtc_ds1307_write_time(uint8_t seconds, uint8_t minutes, uint8_t hours, uint
|
|||
}
|
||||
|
||||
#if defined(RTC_DS1307_SQUARE_WAVE_TICKS)
|
||||
/** @brief timer interrupt service routine called when number of ticks have been received */
|
||||
/** timer interrupt service routine called when number of ticks have been received */
|
||||
void RTC_DS1307_SQUARE_WAVE_TIMER_ISR(void)
|
||||
{
|
||||
if (timer_get_flag(RTC_DS1307_SQUARE_WAVE_TIMER, TIM_SR_UIF)) { // overflow even happened
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@
|
|||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
/** @brief library to communicate with the Maxim DS1307 I2C RTC IC (API)
|
||||
/** library to communicate with the Maxim DS1307 I2C RTC IC (API)
|
||||
* @file rtc_ds1307.h
|
||||
* @author King Kévin <kingkevin@cuvoodoo.info>
|
||||
* @date 2016
|
||||
|
|
@ -57,99 +57,99 @@ extern volatile uint32_t rtc_ds1307_ticks; /**< increment on SQUARE_WAVE_TICS sq
|
|||
extern volatile bool rtc_ds1307_tick_flag; /**< set on SQUARE_WAVE_TICS square wave ticks */
|
||||
#endif
|
||||
|
||||
/** @brief setup communication with RTC IC
|
||||
/** setup communication with RTC IC
|
||||
* configure the I2C port defined in the sources
|
||||
*/
|
||||
void rtc_ds1307_setup(void);
|
||||
/** @brief verify if oscillator is disabled
|
||||
/** verify if oscillator is disabled
|
||||
* @return if oscillator is disabled
|
||||
*/
|
||||
bool rtc_ds1307_oscillator_disabled(void);
|
||||
/** @brief read square wave output frequency (in Hz)
|
||||
/** read square wave output frequency (in Hz)
|
||||
* @return square wave output frequency in Hz, 0 if disabled
|
||||
*/
|
||||
uint16_t rtc_ds1307_read_square_wave(void);
|
||||
/** @brief read seconds from RTC IC
|
||||
/** read seconds from RTC IC
|
||||
* @return number of seconds (0-59) of the current time
|
||||
*/
|
||||
uint8_t rtc_ds1307_read_seconds(void);
|
||||
/** @brief read minutes from RTC IC
|
||||
/** read minutes from RTC IC
|
||||
* @return number of minutes (0-59) of the current time
|
||||
*/
|
||||
uint8_t rtc_ds1307_read_minutes(void);
|
||||
/** @brief read hours from RTC IC
|
||||
/** read hours from RTC IC
|
||||
* @return number of hours (0-23) of the current time
|
||||
*/
|
||||
uint8_t rtc_ds1307_read_hours(void);
|
||||
/** @brief read day from RTC IC
|
||||
/** read day from RTC IC
|
||||
* @return day of the week (1-7, 1 is Sunday) of the current time, 1 being Sunday
|
||||
*/
|
||||
uint8_t rtc_ds1307_read_day(void);
|
||||
/** @brief read date from RTC IC
|
||||
/** read date from RTC IC
|
||||
* @return day of the month (1-31) of the current time
|
||||
*/
|
||||
uint8_t rtc_ds1307_read_date(void);
|
||||
/** @brief read month from RTC IC
|
||||
/** read month from RTC IC
|
||||
* @return month of the year (1-12) of the current time
|
||||
*/
|
||||
uint8_t rtc_ds1307_read_month(void);
|
||||
/** @brief read year from RTC IC
|
||||
/** read year from RTC IC
|
||||
* @return year of the century (00-99) of the current time
|
||||
*/
|
||||
uint8_t rtc_ds1307_read_year(void);
|
||||
/** @brief read time from RTC IC
|
||||
/** read time from RTC IC
|
||||
* @return array of {seconds, minutes, hours, day, date, month, year} as defined above
|
||||
*/
|
||||
uint8_t* rtc_ds1307_read_time(void);
|
||||
/** @brief disable RTC IC oscillator
|
||||
/** disable RTC IC oscillator
|
||||
* @return if disabling oscillator succeeded
|
||||
*/
|
||||
bool rtc_ds1307_oscillator_disable(void);
|
||||
/** @brief enable RTC IC oscillator
|
||||
/** enable RTC IC oscillator
|
||||
* @return if enabling oscillator succeeded
|
||||
*/
|
||||
bool rtc_ds1307_oscillator_enable(void);
|
||||
/** @brief write square wave output frequency (in Hz)
|
||||
/** write square wave output frequency (in Hz)
|
||||
* @param[in] frequency square wave output frequency in Hz (0 to disable, 1, 4096, 8192, 32768)
|
||||
* @return if write succeeded
|
||||
*/
|
||||
bool rtc_ds1307_write_square_wave(uint16_t frequency);
|
||||
/** @brief write seconds into RTC IC
|
||||
/** write seconds into RTC IC
|
||||
* @param[in] seconds number of seconds (0-59)
|
||||
* @return if write succeeded
|
||||
*/
|
||||
bool rtc_ds1307_write_seconds(uint8_t seconds);
|
||||
/** @brief write minutes into RTC IC
|
||||
/** write minutes into RTC IC
|
||||
* @param[in] minutes number of minutes (0-59)
|
||||
* @return if write succeeded
|
||||
*/
|
||||
bool rtc_ds1307_write_minutes(uint8_t minutes);
|
||||
/** @brief write hours into RTC IC
|
||||
/** write hours into RTC IC
|
||||
* @param[in] hours number of hours (0-23)
|
||||
* @return if write succeeded
|
||||
*/
|
||||
bool rtc_ds1307_write_hours(uint8_t hours);
|
||||
/** @brief write day into RTC IC
|
||||
/** write day into RTC IC
|
||||
* @param[in] day day of the week (1-7, 1 is Sunday)
|
||||
* @return if write succeeded
|
||||
*/
|
||||
bool rtc_ds1307_write_day(uint8_t day);
|
||||
/** @brief write date into RTC IC
|
||||
/** write date into RTC IC
|
||||
* @param[in] date day of the month (1-31)
|
||||
* @return if write succeeded
|
||||
*/
|
||||
bool rtc_ds1307_write_date(uint8_t date);
|
||||
/** @brief write month into RTC IC
|
||||
/** write month into RTC IC
|
||||
* @param[in] month month of the year (1-12)
|
||||
* @return if write succeeded
|
||||
*/
|
||||
bool rtc_ds1307_write_month(uint8_t month);
|
||||
/** @brief write year into RTC IC
|
||||
/** write year into RTC IC
|
||||
* @param[in] year year of the century (00-99)
|
||||
* @return if write succeeded
|
||||
*/
|
||||
bool rtc_ds1307_write_year(uint8_t year);
|
||||
/** @brief write time into RTC IC
|
||||
/** write time into RTC IC
|
||||
* @param[in] seconds number of seconds (0-59)
|
||||
* @param[in] minutes number of minutes (0-59)
|
||||
* @param[in] hours number of hours (0-23)
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@
|
|||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
/** @brief library for USART communication (code)
|
||||
/** library for USART communication (code)
|
||||
* @file usart.c
|
||||
* @author King Kévin <kingkevin@cuvoodoo.info>
|
||||
* @date 2016
|
||||
|
|
@ -126,7 +126,7 @@ void usart_putchar_nonblocking(char c)
|
|||
usart_enable_tx_interrupt(USART); // enable transmit interrupt
|
||||
}
|
||||
|
||||
/** @brief USART interrupt service routine called when data has been transmitted or received */
|
||||
/** USART interrupt service routine called when data has been transmitted or received */
|
||||
void USART_ISR(void)
|
||||
{
|
||||
if (usart_get_interrupt_source(USART, USART_SR_TXE)) { // data has been transmitted
|
||||
|
|
|
|||
12
lib/usart.h
12
lib/usart.h
|
|
@ -12,7 +12,7 @@
|
|||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
/** @brief library for USART communication (API)
|
||||
/** library for USART communication (API)
|
||||
* @file usart.h
|
||||
* @author King Kévin <kingkevin@cuvoodoo.info>
|
||||
* @date 2016
|
||||
|
|
@ -25,22 +25,22 @@
|
|||
/** how many bytes available in the received buffer since last read */
|
||||
extern volatile uint8_t usart_received;
|
||||
|
||||
/** @brief setup USART peripheral */
|
||||
/** setup USART peripheral */
|
||||
void usart_setup(void);
|
||||
/** @brief send character over USART (blocking)
|
||||
/** send character over USART (blocking)
|
||||
* @param[in] c character to send
|
||||
* @note blocks until character transmission started */
|
||||
void usart_putchar_blocking(char c);
|
||||
/** @brief ensure all data has been transmitted (blocking)
|
||||
/** ensure all data has been transmitted (blocking)
|
||||
* @note block until all data has been transmitted
|
||||
*/
|
||||
void usart_flush(void);
|
||||
/** @brief get character received over USART (blocking)
|
||||
/** get character received over USART (blocking)
|
||||
* @return character received over USART
|
||||
* @note blocks until character is received over USART when received buffer is empty
|
||||
*/
|
||||
char usart_getchar(void);
|
||||
/** @brief send character over USART (non-blocking)
|
||||
/** send character over USART (non-blocking)
|
||||
* @param[in] c character to send
|
||||
* @note blocks if transmit buffer is full, else puts in buffer and returns
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@
|
|||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
/** @brief library for USB CDC ACM communication (code)
|
||||
/** library for USB CDC ACM communication (code)
|
||||
* @file usb_cdcacm.c
|
||||
* @author King Kévin <kingkevin@cuvoodoo.info>
|
||||
* @date 2016
|
||||
|
|
@ -36,7 +36,7 @@
|
|||
#include "global.h" // global utilities
|
||||
#include "usb_cdcacm.h" // USB CDC ACM header and definitions
|
||||
|
||||
/** @brief USB CDC ACM device descriptor
|
||||
/** USB CDC ACM device descriptor
|
||||
* @note as defined in USB CDC specification section 5
|
||||
*/
|
||||
static const struct usb_device_descriptor device_descriptor = {
|
||||
|
|
@ -56,7 +56,7 @@ static const struct usb_device_descriptor device_descriptor = {
|
|||
.bNumConfigurations = 1, // the number of possible configurations this device has
|
||||
};
|
||||
|
||||
/** @brief USB CDC ACM data endpoints
|
||||
/** USB CDC ACM data endpoints
|
||||
* @note as defined in USB CDC specification section 5
|
||||
*/
|
||||
static const struct usb_endpoint_descriptor data_endpoints[] = {{
|
||||
|
|
@ -75,7 +75,7 @@ static const struct usb_endpoint_descriptor data_endpoints[] = {{
|
|||
.bInterval = 1, // the frequency, in number of frames, that we're going to be sending data
|
||||
}};
|
||||
|
||||
/** @brief USB CDC ACM communication endpoints
|
||||
/** USB CDC ACM communication endpoints
|
||||
* @note This notification endpoint isn't implemented. According to CDC spec its optional, but its absence causes a NULL pointer dereference in Linux cdc_acm driver
|
||||
*/
|
||||
static const struct usb_endpoint_descriptor communication_endpoints[] = {{
|
||||
|
|
@ -87,7 +87,7 @@ static const struct usb_endpoint_descriptor communication_endpoints[] = {{
|
|||
.bInterval = 255, // the frequency, in number of frames, that we're going to be sending data
|
||||
}};
|
||||
|
||||
/** @brief USB CDC ACM functional descriptor
|
||||
/** USB CDC ACM functional descriptor
|
||||
* @return
|
||||
* @note as defined in USB CDC specification section 5.2.3
|
||||
*/
|
||||
|
|
@ -125,7 +125,7 @@ static const struct {
|
|||
},
|
||||
};
|
||||
|
||||
/** @brief USB CDC interface descriptor
|
||||
/** USB CDC interface descriptor
|
||||
* @note as defined in USB CDC specification section 5.1.3
|
||||
*/
|
||||
static const struct usb_interface_descriptor communication_interface[] = {{
|
||||
|
|
@ -145,7 +145,7 @@ static const struct usb_interface_descriptor communication_interface[] = {{
|
|||
.extralen = sizeof(cdcacm_functional_descriptors),
|
||||
}};
|
||||
|
||||
/** @brief USB CDC ACM data class interface descriptor
|
||||
/** USB CDC ACM data class interface descriptor
|
||||
* @note as defined in USB CDC specification section 5.1.3
|
||||
*/
|
||||
static const struct usb_interface_descriptor data_interface[] = {{
|
||||
|
|
@ -162,7 +162,7 @@ static const struct usb_interface_descriptor data_interface[] = {{
|
|||
.endpoint = data_endpoints,
|
||||
}};
|
||||
|
||||
/** @brief USB CDC ACM interface descriptor */
|
||||
/** USB CDC ACM interface descriptor */
|
||||
static const struct usb_interface interfaces[] = {{
|
||||
.num_altsetting = 1,
|
||||
.altsetting = communication_interface,
|
||||
|
|
@ -171,7 +171,7 @@ static const struct usb_interface interfaces[] = {{
|
|||
.altsetting = data_interface,
|
||||
}};
|
||||
|
||||
/** @brief USB CDC ACM configuration descriptor */
|
||||
/** USB CDC ACM configuration descriptor */
|
||||
static const struct usb_config_descriptor config = {
|
||||
.bLength = USB_DT_CONFIGURATION_SIZE, // the length of this header in bytes
|
||||
.bDescriptorType = USB_DT_CONFIGURATION, // a value of 2 indicates that this is a configuration descriptor
|
||||
|
|
@ -185,7 +185,7 @@ static const struct usb_config_descriptor config = {
|
|||
.interface = interfaces, // pointer to an array of interfaces
|
||||
};
|
||||
|
||||
/** @brief USB string table
|
||||
/** USB string table
|
||||
* @note starting with index 1
|
||||
*/
|
||||
static const char *usb_strings[] = {
|
||||
|
|
@ -209,7 +209,7 @@ static volatile uint8_t tx_used = 0; /**< how much data needs to be transmitted
|
|||
mutex_t tx_lock = MUTEX_UNLOCKED; /**< lock to update tx_i or tx_used */
|
||||
volatile uint8_t cdcacm_received = 0; // same as rx_used, but since the user can write this variable we don't rely on it
|
||||
|
||||
/** @brief disconnect USB by pulling down D+ to for re-enumerate */
|
||||
/** disconnect USB by pulling down D+ to for re-enumerate */
|
||||
static void usb_disconnect(void)
|
||||
{
|
||||
/* short USB disconnect to force re-enumerate */
|
||||
|
|
@ -233,7 +233,7 @@ static void usb_disconnect(void)
|
|||
#endif
|
||||
}
|
||||
|
||||
/** @brief incoming USB CDC ACM control request
|
||||
/** incoming USB CDC ACM control request
|
||||
* @param[in] usbd_dev USB device descriptor
|
||||
* @param[in] req control request information
|
||||
* @param[in] buf control request data
|
||||
|
|
@ -292,7 +292,7 @@ static int cdcacm_control_request(usbd_device *usbd_dev, struct usb_setup_data *
|
|||
return 1;
|
||||
}
|
||||
|
||||
/** @brief USB CDC ACM data received callback
|
||||
/** USB CDC ACM data received callback
|
||||
* @param[in] usbd_dev USB device descriptor
|
||||
* @param[in] ep endpoint where data came in
|
||||
*/
|
||||
|
|
@ -314,7 +314,7 @@ static void cdcacm_data_rx_cb(usbd_device *usbd_dev, uint8_t ep)
|
|||
}
|
||||
}
|
||||
|
||||
/** @brief USB CDC ACM data transmitted callback
|
||||
/** USB CDC ACM data transmitted callback
|
||||
* @param[in] usbd_dev USB device descriptor
|
||||
* @param[in] ep endpoint where data came in
|
||||
*/
|
||||
|
|
@ -339,7 +339,7 @@ static void cdcacm_data_tx_cb(usbd_device *usbd_dev, uint8_t ep)
|
|||
usbd_poll(usb_device); // ensure the data gets sent
|
||||
}
|
||||
|
||||
/** @brief set USB CDC ACM configuration
|
||||
/** set USB CDC ACM configuration
|
||||
* @param[in] usbd_dev USB device descriptor
|
||||
* @param[in] wValue not used
|
||||
*/
|
||||
|
|
@ -407,7 +407,7 @@ void cdcacm_putchar(char c)
|
|||
}
|
||||
}
|
||||
|
||||
/** @brief USB interrupt service routine called when data is received */
|
||||
/** USB interrupt service routine called when data is received */
|
||||
void usb_lp_can_rx0_isr(void) {
|
||||
usbd_poll(usb_device);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@
|
|||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
/** @brief library for USB CDC ACM communication (API)
|
||||
/** library for USB CDC ACM communication (API)
|
||||
* @file usb_cdcacm.h
|
||||
* @author King Kévin <kingkevin@cuvoodoo.info>
|
||||
* @date 2016
|
||||
|
|
@ -24,14 +24,14 @@
|
|||
/** how many bytes available in the received buffer since last read */
|
||||
extern volatile uint8_t cdcacm_received;
|
||||
|
||||
/** @brief setup USB CDC ACM peripheral */
|
||||
/** setup USB CDC ACM peripheral */
|
||||
void cdcacm_setup(void);
|
||||
/** @brief get character received over USB (blocking)
|
||||
/** get character received over USB (blocking)
|
||||
* @return character received over USB
|
||||
* @note blocks until character is received over USB when received buffer is empty
|
||||
*/
|
||||
char cdcacm_getchar(void);
|
||||
/** @brief send character over USB (non-blocking)
|
||||
/** send character over USB (non-blocking)
|
||||
* @param[in] c character to send
|
||||
* @note blocks if transmit buffer is full, else puts in buffer and returns
|
||||
*/
|
||||
|
|
|
|||
24
main.c
24
main.c
|
|
@ -12,10 +12,10 @@
|
|||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
/** @file main.c
|
||||
/** show the time on a LED strip
|
||||
* @file main.c
|
||||
* @author King Kévin <kingkevin@cuvoodoo.info>
|
||||
* @date 2016
|
||||
* @brief show the time on a LED strip
|
||||
*/
|
||||
|
||||
/* standard libraries */
|
||||
|
|
@ -154,7 +154,7 @@ char* b2s(uint64_t binary, uint8_t rjust)
|
|||
return &string[bit+1];
|
||||
}
|
||||
|
||||
/** @brief switch off all clock LEDs
|
||||
/** switch off all clock LEDs
|
||||
* @note LEDs need to be set separately
|
||||
*/
|
||||
static void clock_clear(void)
|
||||
|
|
@ -165,7 +165,7 @@ static void clock_clear(void)
|
|||
}
|
||||
}
|
||||
|
||||
/** @brief show time on LED clock
|
||||
/** show time on LED clock
|
||||
* @param[in] time in ticks to show
|
||||
* @details show hours and minutes progress as full arcs, show second position as marker. the brightness of the LED shows the progress of the unit. hours are blue, minutes green, seconds red
|
||||
* @note LEDs need to be set separately
|
||||
|
|
@ -243,7 +243,7 @@ static void clock_show_time(uint32_t time)
|
|||
//clock_leds[second_led*3+2] = 0; // clear other colors (minutes/hours indication)
|
||||
}
|
||||
|
||||
/** @brief set the LEDs
|
||||
/** set the LEDs
|
||||
* @details set the LED colors on WS2812b LEDs
|
||||
* @note WS2812b LED color values need to be transmitted separately
|
||||
*/
|
||||
|
|
@ -254,7 +254,7 @@ static void clock_leds_set(void)
|
|||
}
|
||||
}
|
||||
|
||||
/** @brief set the time on the LEDs
|
||||
/** set the time on the LEDs
|
||||
* @param[in] time time to set
|
||||
*/
|
||||
static void clock_set_time(uint32_t time)
|
||||
|
|
@ -264,7 +264,7 @@ static void clock_set_time(uint32_t time)
|
|||
led_ws2812b_transmit(); // transmit set color
|
||||
}
|
||||
|
||||
/** @brief incrementally set the time on the LEDs
|
||||
/** incrementally set the time on the LEDs
|
||||
* @details this will have an animation where time is incremented until it reaches the provided time
|
||||
* @param[in] time time to set
|
||||
*/
|
||||
|
|
@ -289,7 +289,7 @@ static void clock_animate_time(uint32_t time)
|
|||
}
|
||||
}
|
||||
|
||||
/** @brief show animation with fading hours mark on clock LEDs
|
||||
/** show animation with fading hours mark on clock LEDs
|
||||
*/
|
||||
static void clock_hours(void)
|
||||
{
|
||||
|
|
@ -310,7 +310,7 @@ static void clock_hours(void)
|
|||
}
|
||||
}
|
||||
|
||||
/** @brief process user command
|
||||
/** process user command
|
||||
* @param[in] str user command string (\0 ended)
|
||||
*/
|
||||
static void process_command(char* str)
|
||||
|
|
@ -344,7 +344,7 @@ error:
|
|||
printf("command not recognized. enter help to list commands\n");
|
||||
}
|
||||
|
||||
/** @brief program entry point
|
||||
/** program entry point
|
||||
* this is the firmware function started by the micro-controller
|
||||
*/
|
||||
int main(void)
|
||||
|
|
@ -539,7 +539,7 @@ int main(void)
|
|||
}
|
||||
|
||||
#if defined(BUTTON_ISR) && defined(BUTTON_EXTI)
|
||||
/** @brief interrupt service routine called when button is pressed */
|
||||
/** interrupt service routine called when button is pressed */
|
||||
void BUTTON_ISR(void)
|
||||
{
|
||||
exti_reset_request(BUTTON_EXTI); // reset interrupt
|
||||
|
|
@ -547,7 +547,7 @@ void BUTTON_ISR(void)
|
|||
}
|
||||
#endif
|
||||
|
||||
/** @brief interrupt service routine called when ADC conversion completed */
|
||||
/** interrupt service routine called when ADC conversion completed */
|
||||
void adc1_2_isr(void)
|
||||
{
|
||||
photoresistor_value = adc_read_regular(ADC1); // read measured photo-resistor value (clears interrupt flag)
|
||||
|
|
|
|||
Loading…
Reference in New Issue