VSF Documented
Data Structures | Macros | Typedefs | Functions
vsf_fbcon.c File Reference
#include "component/ui/vsf_ui_cfg.h"
#include "component/ui/disp/vsf_disp.h"
#include "service/simple_stream/vsf_simple_stream.h"
#include "hal/vsf_hal.h"
#include "./vsf_fbcon.h"
#include "./vsf_fbcon_font.h"
#include <string.h>

Data Structures

struct  vsf_fbcon_cell_t
 

Macros

#define __VSF_FBCON_CLASS_IMPLEMENT
 
#define __VSF_DISP_CLASS_INHERIT__
 
#define __VSF_SIMPLE_STREAM_CLASS_INHERIT__
 
#define FBCON_ANSI_STATE_NORMAL   0
 
#define FBCON_ANSI_STATE_ESC   1
 
#define FBCON_ANSI_STATE_CSI   2
 
#define dimof(a)   (sizeof(a) / sizeof((a)[0]))
 

Typedefs

typedef struct vsf_fbcon_cell_t vsf_fbcon_cell_t
 

Functions

vsf_err_t vsf_fbcon_init (vsf_fbcon_t *fbcon)
 
void vsf_fbcon_fini (vsf_fbcon_t *fbcon)
 

Macro Definition Documentation

◆ __VSF_FBCON_CLASS_IMPLEMENT

#define __VSF_FBCON_CLASS_IMPLEMENT

◆ __VSF_DISP_CLASS_INHERIT__

#define __VSF_DISP_CLASS_INHERIT__

◆ __VSF_SIMPLE_STREAM_CLASS_INHERIT__

#define __VSF_SIMPLE_STREAM_CLASS_INHERIT__

◆ FBCON_ANSI_STATE_NORMAL

#define FBCON_ANSI_STATE_NORMAL   0

◆ FBCON_ANSI_STATE_ESC

#define FBCON_ANSI_STATE_ESC   1

◆ FBCON_ANSI_STATE_CSI

#define FBCON_ANSI_STATE_CSI   2

◆ dimof

#define dimof (   a)    (sizeof(a) / sizeof((a)[0]))

Typedef Documentation

◆ vsf_fbcon_cell_t

Function Documentation

◆ vsf_fbcon_init()

vsf_err_t vsf_fbcon_init ( vsf_fbcon_t fbcon)

vsf_fbcon_init - initialize the framebuffer console

Parameters
fbconpointer to a vsf_fbcon_t instance whose public members (disp, stream) have been set by the caller.
Returns
VSF_ERR_NONE on success.

Typical usage: vsf_fbcon_t con; con.disp = &my_display.use_as__vk_disp_t; con.stream = &my_fifo_stream.use_as__vsf_stream_t; vsf_fbcon_init(&con);

◆ vsf_fbcon_fini()

void vsf_fbcon_fini ( vsf_fbcon_t fbcon)

vsf_fbcon_fini - finalize and release fbcon resources

Parameters
fbconpointer to a previously initialized vsf_fbcon_t instance.

Disconnects the stream rx subscription, frees the internal pixel buffer and character grid. The caller-owned disp and stream are NOT touched.

Generated from commit: vsfteam/vsf@c3767bf