trennfix/sw: Added smokefix, further modularized the mm decoder

[eisenbahn.git] / trennfix / sw / mm / include / mm / mm_switch.h

#ifndef MM_SWITCH_H
#define MM_SWITCH_H

#include <stdint.h>
#include <config/hardware.h>

#define MM_FLAVOR_DRIVE 0
#define MM_FLAVOR_SWITCH 1

#ifdef MM_USE_REGISTER_VARS

uint8_t register shift_command  asm("r2");
uint8_t register shift_function asm("r3");
uint8_t register shift_address asm("r4");
uint8_t register mm_polarity asm("r5");
uint8_t register mm_bitno asm("r6");
uint8_t register mm_time_h asm("r9");
uint8_t register mm_time_l asm("r10");
uint8_t register mm_bit_val asm("r11");
uint8_t register mm_flavor asm("r14");

static void inline __attribute((unused)) mm_init(void)
{
	mm_bitno = 0;
	mm_time_h = 0;
	mm_bit_val = 23;
	mm_polarity = 1;
}

#else

#define mm_init(...)

#endif

#ifdef MM_USE_CALLBACK

/*
 * mm_key_cb - Callback function!
 *
 * This function must be defined whenever the mm_switch module is used.
 * It will be called from interrupt context whenever a new valid command
 * has arrived.
 *
 * decoder is in the range from 1 to 25. Other values will not occur.
 *
 * key is in the range from 0 to 8:
 *
 *   1 - key1 green pressed
 *   2 - key1 red pressed
 *   3 - key2 green pressed
 *   4 - key2 red pressed
 *   ...
 *   0 - all keys up
 *
 */
void mm_key_cb(uint8_t decoder, uint8_t function, uint8_t key);
void mm_drive_cb(uint8_t decoder, uint8_t function, uint8_t command);

#endif

void mm_pinchange_callback(void);

enum mm_recmode {
	__MM_INIT,
	__MM_ARMED,
	MM_SLOW,
	MM_FAST,
};

#ifdef MM_USE_QUEUE

struct mm_command {
	enum mm_recmode recmode; /* Only MM_FAST or MM_SLOW!       */
	uint8_t address;         /* Undecoded loco/decoder address */
	uint8_t function;        /* The two function bits          */
	uint8_t command;         /* Button/Speed/Functions         */
};

struct mm_command *mm_get(void);

#endif /* MM_USE_QUEUE */

#endif