Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve documentation for foe_file_cfg #154

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve documentation for foe_file_cfg #154

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions soes/esc_foe.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ typedef struct foe_file_cfg foe_file_cfg_t;
struct foe_file_cfg
{
/** Name of file to receive from master */
const char * name;
const char * name;
/** Size of file,sizeof data we can recv */
uint32_t max_data;
/** Where to store the data initially */
Expand All @@ -35,7 +35,9 @@ struct foe_file_cfg
uint8_t write_only_in_boot;
/** for feature use */
uint32_t padding:24;
/** Pointer to application foe write function */
/** Pointer to application FoE write function
* At the last write for each file, the \a length value is less that the FoE \a buffer_size.
* Return 0 on success, and non-zero on failure */
uint32_t (*write_function) (foe_file_cfg_t * self, uint8_t * data, size_t length);
};

Expand Down