Skip to content

Commit

Permalink
Merge pull request #368 from thnkslprpt/fix-276-update-out-of-date-do…
Browse files Browse the repository at this point in the history
…xygen-text

Fix #276, Update out-of-date doxygen text
  • Loading branch information
dzbaker authored Mar 2, 2023
2 parents 19c18b9 + 27446e4 commit c44e372
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions docs/dox_src/cfs_cf.dox
Original file line number Diff line number Diff line change
Expand Up @@ -478,19 +478,23 @@

<H2> Configuration </H2>
CF uses two sets of configuration parameters: compile-time configurable parameters
in the cf_platform_cfg.h file and run-time configurable parameters in the cf_def_cfg.c
file. Most parameters are included in the cf_def_cfg.c file for maximum flexibility.
in the cf_platform_cfg.h file and run-time configurable parameters in the cf_def_config.c
file. Most parameters are included in the cf_def_config.c file for maximum flexibility.

cf_platform_cfg.h uses macro definitions for configurable options, while cf_def_config.c
uses a table. cf_def_config.c parameters can be accessed using the get/set functions
CF_CmdGetParam() and CF_CmdSetParam().

CF expects to receive a CF_WAKEUP_MID message from the SCH (scheduler) app at a fixed
rate. The number of wakeups per second is reflected in the configuration table. This
drives CF's timing.

<H3> Channels </H3>

CF version 3.0 has a concept of "channels" which have their own
configuration. The channel configuration is done in the cf_def_cfg and allows
message IDs for incoming and outgoing PDUs to be unique per channel. Each channel can be
configured with polling directories as well.
CF version 3.0 has a concept of "channels" which have their own configuration. The
channel configuration is done in the cf_def_config.c file and allows message IDs for
incoming and outgoing PDUs to be unique per channel. Each channel can be configured with
polling directories as well.

<H3> Flow Control </H3>

Expand Down

0 comments on commit c44e372

Please sign in to comment.