File based operations

Data Structures
struct	kfsw_fbo_status

Functions
int	kfsw_fbo_init (void)
int	kfsw_fbo_run (const char *name)
int	kfsw_fbo_stop (void)
int	kfsw_fbo_get_status (struct kfsw_fbo_status *status)

Variables
const struct kfsw_param_definition_set	kfsw_fbo_param_definitions

Description

Run a list of commands from a file.

Every line is a normal command, and there are no loops or jumps.

Function Documentation

kfsw_fbo_get_status()

int kfsw_fbo_get_status

(

struct kfsw_fbo_status *

status

)

#include <fbo.h>

Read procedure state and counters.

Parameters

[out]

status

Destination.

Return values

0	Written.
-EINVAL	status is NULL.

kfsw_fbo_init()

int kfsw_fbo_init

(

void

)

#include <fbo.h>

Initialize the service.

Return values

0	Ready, or already initialized.

kfsw_fbo_run()

int kfsw_fbo_run

(

const char *

name

)

#include <fbo.h>

Start a procedure.

Returns once the run is accepted; the procedure runs on the service thread. Follow it with kfsw_fbo_get_status() or the event record.

Parameters

name	File under the procedure directory, without a path.

Return values

0	The run was accepted.
-EINVAL	name is NULL, empty, too long, or contains a path.
-EACCES	The service is not initialized.
-EBUSY	A procedure is already running.
-ENOENT	No such procedure.
-ENODEV	There is no storage.
-EISDIR	The name refers to a directory.
-EFBIG	The file exceeds CONFIG_KFSW_FBO_BYTES_MAX.

kfsw_fbo_stop()

int kfsw_fbo_stop

(

void

)

#include <fbo.h>

Ask a running procedure to stop.

Wakes a wait immediately. Other command handlers finish before the stop takes effect. Stopping while idle has no effect on the next run.

Return values

0	A stop was requested, or nothing was running.

Variable Documentation

kfsw_fbo_param_definitions

const struct kfsw_param_definition_set kfsw_fbo_param_definitions

extern

#include <fbo.h>

Parameter table of file based operations.