From fe95ea221b2b88e9cb52a6378ff2018ee752094b Mon Sep 17 00:00:00 2001 From: Kevin O'Connor Date: Thu, 22 Dec 2016 23:47:46 -0500 Subject: build: Define DECL_CONSTANT mechanism for defining exported constants Add a DECL_CONSTANT macro to allow the firmware to define constants that are to be exported to the host during the "identify" phase. This replaces the existing hardcoded mechanism of scanning the Kconfig header file for certain constants. Signed-off-by: Kevin O'Connor --- docs/Protocol.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) (limited to 'docs/Protocol.md') diff --git a/docs/Protocol.md b/docs/Protocol.md index 12d5e1ce..bd11400f 100644 --- a/docs/Protocol.md +++ b/docs/Protocol.md @@ -109,6 +109,19 @@ to generate and format arbitrary messages for human consumption. It is a wrapper around sendf() and as with sendf() it should not be called from interrupts or timers. +Declaring constants +------------------- + +The firmware can also define constants to be exported. For example, +the following: + +``` +DECL_CONSTANT(SERIAL_BAUD, 250000); +``` + +would export a constant named "SERIAL_BAUD" with a value of 250000 +from the firmware to the host. + Low-level message encoding ========================== @@ -262,8 +275,8 @@ dictionary. Once all chunks are obtained the host will assemble the chunks, uncompress the data, and parse the contents. In addition to information on the communication protocol, the data -dictionary also contains firmware version, configuration, and other -useful information. +dictionary also contains firmware version, constants (as defined by +DECL_CONSTANT), and static strings. Static Strings -------------- -- cgit v1.2.3-70-g09d2