BV: fix doc
This commit is contained in:
parent
3bde5daecd
commit
5f889ba8b0
|
@ -106,12 +106,12 @@
|
||||||
|
|
||||||
/** BusVoodoo mode interface */
|
/** BusVoodoo mode interface */
|
||||||
struct busvoodoo_mode_t {
|
struct busvoodoo_mode_t {
|
||||||
const char* name;
|
const char* name; /**< name of the mode (i.e. protocol shortcut for the menu) */
|
||||||
const char* description;
|
const char* description; /**< human readable description of the mode (i.e. full protocol name) */
|
||||||
bool (*setup)(char** prefix, const char* line);
|
bool (*setup)(char** prefix, const char* line); /**< function to setup mode (menu prefix can be used to ask parameter, and line will be the user provided response)*/
|
||||||
const struct menu_command_t* commands;
|
const struct menu_command_t* commands; /**< list of menu commands provided by mode */
|
||||||
const uint8_t commands_nb;
|
const uint8_t commands_nb; /**< number of menu commands provided by mode */
|
||||||
void (*exit)(void);
|
void (*exit)(void); /**< function to exit from mode (i.e. releasing the peripheral) */
|
||||||
};
|
};
|
||||||
|
|
||||||
/** @defgroup busvoodoo_io I/O connector pin definition
|
/** @defgroup busvoodoo_io I/O connector pin definition
|
||||||
|
@ -181,7 +181,7 @@ void busvoodoo_led_blue(uint16_t ms);
|
||||||
void busvoodoo_led_red(uint16_t ms);
|
void busvoodoo_led_red(uint16_t ms);
|
||||||
/** parse and perform actions
|
/** parse and perform actions
|
||||||
* @note performing action is a common command in mode and this function helps parsing them
|
* @note performing action is a common command in mode and this function helps parsing them
|
||||||
* @param[io] actions actions to perform
|
* @param[in] actions actions to perform
|
||||||
* @param[in] perform the action (true) or just check it (false)
|
* @param[in] perform the action (true) or just check it (false)
|
||||||
* @param[in] action_handler function handling the individual actions
|
* @param[in] action_handler function handling the individual actions
|
||||||
* @return true if the actions have been performed, false if any of them is malformed
|
* @return true if the actions have been performed, false if any of them is malformed
|
||||||
|
|
|
@ -1006,6 +1006,7 @@ static void busvoodoo_hiz_command_test_pins(void* argument)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** HiZ menu commands */
|
||||||
static const struct menu_command_t busvoodoo_hiz_commands[] = {
|
static const struct menu_command_t busvoodoo_hiz_commands[] = {
|
||||||
{
|
{
|
||||||
'v',
|
'v',
|
||||||
|
|
|
@ -48,7 +48,7 @@ static enum busvoodoo_i2c_setting_t {
|
||||||
BUSVOODOO_I2C_SETTING_ADDRESSBITS,
|
BUSVOODOO_I2C_SETTING_ADDRESSBITS,
|
||||||
BUSVOODOO_I2C_SETTING_PULLUP,
|
BUSVOODOO_I2C_SETTING_PULLUP,
|
||||||
BUSVOODOO_I2C_SETTING_DONE,
|
BUSVOODOO_I2C_SETTING_DONE,
|
||||||
} busvoodoo_i2c_setting = BUSVOODOO_I2C_SETTING_NONE;
|
} busvoodoo_i2c_setting = BUSVOODOO_I2C_SETTING_NONE; /**< current mode setup stage */
|
||||||
/** I2C speed (in kHz) */
|
/** I2C speed (in kHz) */
|
||||||
uint16_t busvoodoo_i2c_speed = 100;
|
uint16_t busvoodoo_i2c_speed = 100;
|
||||||
/** I2C address bits (7 or 10) */
|
/** I2C address bits (7 or 10) */
|
||||||
|
@ -491,6 +491,7 @@ static void busvoodoo_i2c_command_scan(void* argument)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** I2C menu commands */
|
||||||
static const struct menu_command_t busvoodoo_i2c_commands[] = {
|
static const struct menu_command_t busvoodoo_i2c_commands[] = {
|
||||||
{
|
{
|
||||||
'a',
|
'a',
|
||||||
|
|
|
@ -16,7 +16,7 @@
|
||||||
* @file busvoodoo_oled.c
|
* @file busvoodoo_oled.c
|
||||||
* @author King Kévin <kingkevin@cuvoodoo.info>
|
* @author King Kévin <kingkevin@cuvoodoo.info>
|
||||||
* @date 2018
|
* @date 2018
|
||||||
* @note peripherals used: I2C @ref i2c_master_i2c, timer @ref i2c_master_timer
|
* @note peripherals used: I2C @ref oled_ssd1306_i2c
|
||||||
*/
|
*/
|
||||||
/* standard libraries */
|
/* standard libraries */
|
||||||
#include <stdint.h> // standard integer types
|
#include <stdint.h> // standard integer types
|
||||||
|
|
|
@ -16,7 +16,7 @@
|
||||||
* @file busvoodoo_oled.h
|
* @file busvoodoo_oled.h
|
||||||
* @author King Kévin <kingkevin@cuvoodoo.info>
|
* @author King Kévin <kingkevin@cuvoodoo.info>
|
||||||
* @date 2018
|
* @date 2018
|
||||||
* @note peripherals used: I2C @ref i2c_master_i2c, timer @ref i2c_master_timer
|
* @note peripherals used: I2C @ref oled_ssd1306_i2c
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** setup OLED display */
|
/** setup OLED display */
|
||||||
|
@ -28,16 +28,18 @@ void busvoodoo_oled_clear(void);
|
||||||
/** draw mode text on top (yellow) left side in display buffer
|
/** draw mode text on top (yellow) left side in display buffer
|
||||||
* @warning this clears the top line, including the text on the right side
|
* @warning this clears the top line, including the text on the right side
|
||||||
* @note update the display to display the text
|
* @note update the display to display the text
|
||||||
|
* @param[in] text text to display on top left side of screen
|
||||||
*/
|
*/
|
||||||
void busvoodoo_oled_text_left(char* text);
|
void busvoodoo_oled_text_left(char* text);
|
||||||
/** draw mode text on top (yellow) right side in display buffer
|
/** draw mode text on top (yellow) right side in display buffer
|
||||||
* @warning this does not clear the top line, including the text on the right side
|
* @warning this does not clear the top line, including the text on the right side
|
||||||
* @note update the display to display the text
|
* @note update the display to display the text
|
||||||
|
* @param[in] text text to display on top right side of screen
|
||||||
*/
|
*/
|
||||||
void busvoodoo_oled_text_right(char* text);
|
void busvoodoo_oled_text_right(char* text);
|
||||||
/** draw pin names on bottom (blue) part in display buffer
|
/** draw pin names on bottom (blue) part in display buffer
|
||||||
* @param[in] pins pin names
|
* @param[in] pins pin names
|
||||||
* @param[in] io_header display I/O connector (true) or RS/CAN connector + top half of I/O connector (false)
|
* @param[in] io_connector display I/O connector (true) or RS/CAN connector + top half of I/O connector (false)
|
||||||
* @note update the display to display the text
|
* @note update the display to display the text
|
||||||
*/
|
*/
|
||||||
void busvoodoo_oled_text_pinout(const char* pins[10], bool io_connector);
|
void busvoodoo_oled_text_pinout(const char* pins[10], bool io_connector);
|
||||||
|
|
|
@ -52,7 +52,7 @@ static enum busvoodoo_spi_setting_t {
|
||||||
BUSVOODOO_SPI_SETTING_MODE,
|
BUSVOODOO_SPI_SETTING_MODE,
|
||||||
BUSVOODOO_SPI_SETTING_DRIVE,
|
BUSVOODOO_SPI_SETTING_DRIVE,
|
||||||
BUSVOODOO_SPI_SETTING_DONE,
|
BUSVOODOO_SPI_SETTING_DONE,
|
||||||
} busvoodoo_spi_setting = BUSVOODOO_SPI_SETTING_NONE;
|
} busvoodoo_spi_setting = BUSVOODOO_SPI_SETTING_NONE; /**< current mode setup stage */
|
||||||
/** SPI duplex mode (true = full-duplex, false = bidirectional) */
|
/** SPI duplex mode (true = full-duplex, false = bidirectional) */
|
||||||
static bool busvoodoo_spi_duplex = true;
|
static bool busvoodoo_spi_duplex = true;
|
||||||
/** SPI baud rate (corresponding to baud rate control, e.g. 36MHz/(2<<br))) */
|
/** SPI baud rate (corresponding to baud rate control, e.g. 36MHz/(2<<br))) */
|
||||||
|
@ -475,6 +475,7 @@ static void busvoodoo_spi_command_actions(void* argument)
|
||||||
free(copy); // release memory
|
free(copy); // release memory
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** SPI menu commands */
|
||||||
static const struct menu_command_t busvoodoo_spi_commands[] = {
|
static const struct menu_command_t busvoodoo_spi_commands[] = {
|
||||||
{
|
{
|
||||||
'a',
|
'a',
|
||||||
|
|
Loading…
Reference in New Issue