moat_internal.h

Go to the documentation of this file.

#ifndef MOAT_I_H
#define MOAT_I_H

/*
 *  Copyright © 2010-2015, Matthias Urlichs <matthias@urlichs.de>
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License (included; see the file LICENSE)
 *  for more details.
 */

#include "moat.h"

#define MAXBUF 32

/* transmit the CRC, check that its complement is received correctly.
   If it is not, this will not return to the caller.
   */
void end_transmission(uint16_t crc);

typedef void init_fn(void);
typedef void poll_fn(void);
typedef uint8_t read_len_fn(uint8_t chan);
typedef void read_fn(uint8_t chan, uint8_t *buf);
typedef void read_done_fn(uint8_t chan);
typedef char alert_check_fn(void);
typedef void alert_fill_fn(uint8_t *buf);
typedef void write_check_fn(uint8_t chan, uint8_t *buf, uint8_t len);
typedef void write_fn(uint8_t chan, uint8_t *buf, uint8_t len);

#define DEFS(_s) \
    init_fn init_ ## _s; \
    poll_fn poll_ ## _s; \
    read_len_fn read_ ## _s ## _len; \
    read_fn read_ ## _s; \
    read_done_fn read_ ## _s ## _done; \
    write_check_fn write_ ## _s ## _check;  \
    write_fn write_ ## _s;  \
    ADEFS(_s)

#ifdef CONDITIONAL_SEARCH
#define ADEFS(_s) \
    alert_check_fn alert_ ## _s ## _check; \
    alert_fill_fn alert_ ## _s ## _fill;
#else
#define ADEFS(_s) // nothing
#endif

#define ALIASDEFS(_s) \
    init_fn init_ ## _s __attribute__((weak,alias("dummy_init_fn"))); \
    poll_fn poll_ ## _s __attribute__((weak,alias("dummy_poll_fn"))); \
    read_len_fn read_ ## _s ## _len __attribute__((weak,alias("dummy_read_len_fn"))); \
    read_fn read_ ## _s __attribute__((weak,alias("dummy_read_fn"))); \
    read_done_fn read_ ## _s ## _done __attribute__((weak,alias("dummy_read_done_fn"))); \
    write_check_fn write_ ## _s ## _check __attribute__((weak,alias("dummy_write_check_fn")));  \
    write_fn write_ ## _s __attribute__((weak,alias("dummy_write_fn")));  \
        ALERT_ALIASDEF(_s)
#ifdef CONDITIONAL_SEARCH
#define ALERT_ALIASDEF(_s) \
    alert_check_fn alert_ ## _s ## _check __attribute__((weak,alias("dummy_alert_check_fn"))); \
    alert_fill_fn alert_ ## _s ## _fill __attribute__((weak,alias("dummy_alert_fill_fn")));
#else 
#define ALERT_ALIASDEF(x) // nothing
#endif

#define FUNCPTRS(_s) \
{ \
    &init_ ## _s, \
    &poll_ ## _s, \
    &read_ ## _s ## _len, \
    &read_ ## _s, \
    &read_ ## _s ## _done, \
    &write_ ## _s ## _check, \
    &write_ ## _s, \
    ALERTPTRS(_s) \
}
#ifdef CONDITIONAL_SEARCH
#define ALERTPTRS(_s) \
    &alert_ ## _s ## _check, \
    &alert_ ## _s ## _fill, 
#else
#define ALERTPTRS(x) // nothing
#endif

typedef struct {
    init_fn *init;
    poll_fn *poll;
    read_len_fn *read_len;
    read_fn *read;
    read_done_fn *read_done;
    write_check_fn *write_check;
    write_fn *write;
#ifdef CONDITIONAL_SEARCH
    alert_check_fn *alert_check;
    alert_fill_fn *alert_fill;
#endif
} moat_call_t;
extern const moat_call_t moat_calls[TC_MAX] __attribute__ ((progmem));

extern const uint8_t moat_sizes[TC_MAX] __attribute__ ((progmem));

#if defined(IS_BOOTLOADER) || defined(USE_BOOTLOADER)
typedef struct {
    char sig[2]; // 'ML'
    init_fn *init;
    const moat_call_t *calls;
    uint8_t n_types;
} moat_loader_t;
#endif

#define TC_DEFINE(x) \
    DEFS(x)
#include "_def.h"
#undef TC_DEFINE

extern uint8_t moat_buf[MAXBUF];
extern uint8_t moat_alert_present;

#endif // moat_internal.h