console.h

Go to the documentation of this file.

/*
 * console.h
 *
 * Part of librfn (a general utility library from redfelineninja.org.uk)
 *
 * Copyright (C) 2014 Daniel Thompson <daniel@redfelineninja.org.uk>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 */

#ifndef RF_CONSOLE_H_
#define RF_CONSOLE_H_

#include <stdio.h>

#include "fibre.h"
#include "ringbuf.h"

struct console;

typedef struct {
        const char *name;
        pt_state_t (*fn)(struct console *c);
} console_cmd_t;

#define CONSOLE_CMD_VAR_INIT(n, f)                                             \
        {                                                                      \
                .name = (n),                                                   \
                .fn = (f)                                                      \
        }

#define SCRATCH_SIZE 80

typedef struct console {
        fibre_t fibre;

        FILE *out;

        char ringbuf[16];
        ringbuf_t ring;

        union {
                char buf[SCRATCH_SIZE];
                uint8_t u8[SCRATCH_SIZE];
                uint16_t u16[SCRATCH_SIZE/2];
                uint32_t u32[SCRATCH_SIZE/4];
                void *p[SCRATCH_SIZE/4];
        } scratch;
        char *bufp;

        int argc;
        char *argv[4];

        const console_cmd_t *cmd;
        pt_t pt;
} console_t;

void console_init(console_t *c, FILE *f);

void console_hwinit(console_t *c);

static inline void console_silent(console_t *c) { c->argc = 1; }

int console_register(const console_cmd_t *cmd);

void console_putchar(console_t *c, char d);

pt_state_t console_eval(pt_t *pt, console_t *c, const char *cmd);

int console_getch(console_t *c);

pt_state_t console_run(console_t *c);

void console_process(console_t *c, char d);

typedef enum {
        console_gpio_active_low = 0x01,
        console_gpio_default_on = 0x02,
        console_gpio_open_drain = 0x04,
        console_gpio_explore = 0x08
} console_gpio_flags_t;

typedef struct {
        console_cmd_t cmd;
        uintptr_t port;
        uint32_t pin;
        int flags;
} console_gpio_t;

pt_state_t console_gpio_do_cmd(console_t *c);

#define CONSOLE_GPIO_VAR_INIT(name, port_, pin_, flags_)                       \
        {                                                                      \
                .cmd = CONSOLE_CMD_VAR_INIT(name, console_gpio_do_cmd),        \
                .port = port_, .pin = pin_, .flags = flags_                    \
        }

int console_gpio_register(const console_gpio_t *gpio);

#endif // RF_CONSOLE_H_