fly316/PX4-Autopilot
7
0
Fork 0
mirror of https://gitee.com/mirrors_PX4/PX4-Autopilot.git synced 2026-10-20 23:03:35 +08:00
Code Issues Packages Projects Releases Wiki Activity

module docs: add PRINT_MODULE_USAGE_PARAMS_I2C_{SPI_DRIVER,ADDRESS}

Browse Source 
For SPI/I2C driver default options
This commit is contained in:
Beat Küng
2020-03-17 23:31:17 -04:00
committed by Daniel Agar
parent f851f65f8d
commit d1f5b23a5a
3 changed files with 77 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
platforms/common/include/px4_platform_common/module.h
+11
View File
@@ -499,6 +499,17 @@ __EXPORT void PRINT_MODULE_USAGE_COMMAND_DESCR(const char *name, const char *des
PRINT_MODULE_USAGE_COMMAND("stop"); \
PRINT_MODULE_USAGE_COMMAND_DESCR("status", "print status info");
/**
* Print default params for I2C or SPI drivers
* @param i2c_support true if the driver supports I2C
* @param spi_support true if the driver supports SPI
*/
__EXPORT void PRINT_MODULE_USAGE_PARAMS_I2C_SPI_DRIVER(bool i2c_support, bool spi_support);
/**
* Configurable I2C address (via -a <address>)
*/
__EXPORT void PRINT_MODULE_USAGE_PARAMS_I2C_ADDRESS(uint8_t default_address);
/** @note Each of the PRINT_MODULE_USAGE_PARAM_* methods apply to the previous PRINT_MODULE_USAGE_COMMAND_DESCR(). */
platforms/common/module.cpp
+29
View File
@@ -89,6 +89,35 @@ void PRINT_MODULE_USAGE_PARAM_COMMENT(const char *comment)
PX4_INFO_RAW("\n %s\n", comment);
}
void PRINT_MODULE_USAGE_PARAMS_I2C_SPI_DRIVER(bool i2c_support, bool spi_support)
{
// Note: this must be kept in sync with Tools/px4moduledoc/srcparser.py
if (i2c_support) {
PRINT_MODULE_USAGE_PARAM_FLAG('I', "Internal I2C bus(es)", true);
PRINT_MODULE_USAGE_PARAM_FLAG('X', "External I2C bus(es)", true);
}
if (spi_support) {
PRINT_MODULE_USAGE_PARAM_FLAG('s', "Internal SPI bus(es)", true);
PRINT_MODULE_USAGE_PARAM_FLAG('S', "External SPI bus", true);
}
PRINT_MODULE_USAGE_PARAM_INT('b', -1, 0, 16, "bus (board-specific internal (default=all) or n-th external (default=1))",
true);
if (spi_support) {
PRINT_MODULE_USAGE_PARAM_INT('c', 1, 1, 10, "chip-select index (for external SPI)", true);
PRINT_MODULE_USAGE_PARAM_INT('m', -1, 0, 3, "SPI mode", true);
}
PRINT_MODULE_USAGE_PARAM_INT('f', -1, 0, 100000, "bus frequency in kHz", true);
}
void PRINT_MODULE_USAGE_PARAMS_I2C_ADDRESS(uint8_t default_address)
{
PRINT_MODULE_USAGE_PARAM_INT('a', default_address, 0, 0xff, "I2C address", true);
}
void PRINT_MODULE_USAGE_PARAM_INT(char option_char, int default_val, int min_val, int max_val,
const char *description, bool is_optional)
{