librfn
An ad-hoc utility library
Data Structures | Macros | Typedefs | Enumerations | Functions
console.h File Reference
#include <stdio.h>
#include "fibre.h"
#include "ringbuf.h"

Go to the source code of this file.

Data Structures

struct  console_cmd_t
 Console command descriptor. More...
 
struct  console
 Console descriptor. More...
 
struct  console_gpio_t
 GPIO command descriptor. More...
 

Macros

#define CONSOLE_CMD_VAR_INIT(n, f)
 
#define SCRATCH_SIZE   80
 
#define CONSOLE_GPIO_VAR_INIT(name, port_, pin_, flags_)
 

Typedefs

typedef struct console console_t
 Console descriptor. More...
 

Enumerations

enum  console_gpio_flags_t { console_gpio_active_low = 0x01, console_gpio_default_on = 0x02, console_gpio_open_drain = 0x04, console_gpio_explore = 0x08 }
 Request special features from the GPIO command. More...
 

Functions

void console_init (console_t *c, FILE *f)
 Initialized the console handler. More...
 
void console_hwinit (console_t *c)
 Platform dependant function that will be called during console_init(). More...
 
int console_register (const console_cmd_t *cmd)
 Register a new command. More...
 
void console_putchar (console_t *c, char d)
 Asynchronously send a character to the command processor. More...
 
pt_state_t console_eval (pt_t *pt, console_t *c, const char *cmd)
 Proto-thread to inject a string into the command parser. More...
 
int console_getch (console_t *c)
 Fetch a character from the command processors queue. More...
 
pt_state_t console_run (console_t *c)
 Console protothread entrypoint. More...
 
void console_process (console_t *c, char d)
 Synchronous console function for use in threaded environments. More...
 
int console_gpio_register (const console_gpio_t *gpio)
 Register a new GPIO command. More...