pinkit.h

#ifndef PINKIT_H
#define PINKIT_H

#include "pinkit_defs.h"
#include "types.h"

//define PK_SOUND
//define AUXGI_MODE

#if defined(PK_SOUND)
  #warning pinkit.h: pk_sound mode in pk_common
#endif

/* These should be in pinkit_defs.h file */
#define COIL0           LATAbits.LATA5
#define COIL1           LATAbits.LATA4
#define COIL2           LATAbits.LATA3
#define COIL3           LATAbits.LATA2
#define COIL4           coil_dummy
#define COIL5           coil_dummy
#define COIL6           coil_dummy
#define COIL7           coil_dummy

#define LAMP0           LATAbits.LATA0
#define LAMP1           LATAbits.LATA1
#define LAMP2           LATBbits.LATB6
#define LAMP3           LATBbits.LATB7
#define LAMP4           LATCbits.LATC4
#define LAMP5           LATCbits.LATC5
#define LAMP6           LATCbits.LATC6
#define LAMP7           LATCbits.LATC7

#define SW0             PORTCbits.RC0
#define SW1             PORTCbits.RC1
#define SW2             PORTCbits.RC2
#define SW3             PORTCbits.RC3
#define SW4             PORTCbits.RC4
#define SW5             PORTCbits.RC5
#define SW6             PORTCbits.RC6
#define SW7             PORTCbits.RC7

#define ID0             PORTBbits.RB5
#define ID1             PORTBbits.RB4
#define ID2             PORTBbits.RB1
#define ID3             PORTBbits.RB0


//define BLINK_RATE(n)   (UINT16) (2000L >> (n))
#define ERROR_FLAG(n)   reg[15] |= ((BYTE)(1UL << (n)))
#define TEST_DELAY      200


/* Note that space is reserved for 16 devices to avoid having out-of-range checks on the */
/* incoming messages.  Targeting a device that doesn't exist will be a no-op. */
#if defined (PK_SOUND)
  #define MAX_LAMPS     0
  #define MAX_SWITCHES  1
  #define MAX_COILS     0
  #define MAX_DIGITS    1
  #define MAX_REGS      16
#else
  #if !defined (MAX_LAMPS)
  #define MAX_LAMPS     16
  #endif
  #define MAX_SWITCHES  16
  #define MAX_COILS     16
  #define MAX_DIGITS     7
  #define MAX_REGS      16
#endif

#if !defined(MAX_PLAYER)
#define MAX_PLAYER       1
#endif

#if !defined(COIL_PULSE)
#define COIL_PULSE       40
#endif

#if !defined(MAX_CREDITS)
#define MAX_CREDITS             29
#endif

#if !defined(PK_SOUND)
  #if !defined(MAX_ATTRACT)
    #define MAX_ATTRACT     64
  #endif
#endif
#define BALL_WDT        200     /* 20 seconds */

typedef union PK_MSG_ID_T {
   unsigned long id;
   struct {
      BYTE BYTE_0;
      BYTE BYTE_1;
      BYTE BYTE_2;
      BYTE BYTE_3;
   } u;
} PK_MSG_ID;

struct LAMP {
  BYTE state;           
  BYTE group;           
  union {
    UINT16 patt_all;         
    struct { BYTE patt_lo;   
             BYTE patt_hi;   
           };
    } pattern;          
  UINT16 timer;         
  BYTE blink;           
};
extern BYTE cmd_patt[2];

#define SW_LEVEL        0x7F
#define SW_EDGE_SLOWEST 0x3F
#define SW_EDGE_SLOW    0x1F
#define SW_EDGE_MED     0x07
#define SW_EDGE         0x03
#define SW_EDGE_FAST    0x01

struct SW {
  BYTE state;           
  BYTE type;            
  BYTE score;           
  BYTE coil;            
  BYTE cmd[2];          
};

struct COIL {
  BYTE state;           
  BYTE timer;           
  BYTE max;             
};

struct PK_CMD_FUNC {
  BYTE ttype;              
  union  {
     BYTE cmd[2];          
     void (*func)(void);   
  } fc;                    
};

struct EVENT {
  BYTE next;
  struct PK_CMD_FUNC u;
};

struct PK_QCMD {
  BYTE cmd1;    
  BYTE cmd2;    
};

#ifdef CPU_MODE
#define ATTRACT_OFF             0
#define ATTRACT_SWEEP_LEFT      1
#define ATTRACT_SWEEP_RIGHT     2
#define ATTRACT_CHASE           3
#define ATTRACT_SWEEP_UP        4
#define ATTRACT_SWEEP_DOWN      5
#define ATTRACT_FADE_ON         6
#define ATTRACT_FADE_OFF        7
#define ATTRACT_TWINKLE         8
#define ATTRACT_RANDOM          9
#define ATTRACT_RESET          10
#define MAX_ATTRACT_MODE        9

extern struct {
  BYTE lampID;
  BYTE x;
  BYTE y;
} attract[64];
extern BYTE attract_rate;
extern BYTE attract_enable = 0xFF;
#endif

typedef enum {
  MS_RESET = 0,   
  MS_GAME_OVER,   
  MS_NEW_GAME,    
  MS_NEW_BALL,
  MS_LAUNCH_BALL,
  MS_PLAY_BALL,   
  MS_COLLECT_BONUS,
  MS_END_BALL,
  MS_CUSTOM1,    
  MS_CUSTOM2,    
  MS_MATCH1,
  MS_MATCH2,
  MS_END_GAME,
  MS_ABORT_GAME,
  MS_TILT,
  MS_SLAM,
  MS_SLAM_HOLD,
  MS_ATTRACT, MS_ATTRACT_OFF,
  MS_NV_UPDATE,
  MS_DIAG, MS_DIAG_ADJUST1, MS_DIAG_ADJUST2, MS_DIAG_LAMP, MS_DIAG_COIL, MS_DIAG_SWITCH, MS_DIAG_PINCAN,
  MS_CLOCK }  MACHINE_STATE;

//define ID_PANIC      0x110    /* Lower IDs have higher priority in CAN protocol */
//define ID_DIAG       0x120
//define ID_COIL       0x140
//define ID_SW         0x150
//define ID_LAMP       0x160
//define ID_SCORE      0x180
//define ID_SOUND      0x190
//define ID_LOWPRI     0x1E0

#define MSG_REG_READ  0x00
#define MSG_REG_WRITE 0x10
#define MSG_2         0x20
#define MSG_VOLUME    0x30
#define MSG_COIL      0x40
#define MSG_SW        0x50
#define MSG_LAMP      0x60
#define MSG_LGROUP    0x70
#define MSG_SCORE     0x80
#define MSG_SOUND     0x90
#define MSG_PLAY      0x90
#define MSG_ASSIGN    0xA0
#define MSG_BLINK     0xB0
#define MSG_CTL       0xC0
#define MSG_D         0xD0
#define MSG_XOP       0xE0
#define MSG_USER      0xF0

#define MSG_COIL_OFF   (MSG_COIL | 0x00)
#define MSG_COIL_ON    (MSG_COIL | 0x0F)
#define MSG_COIL_PULSE (MSG_COIL | 0x03)

#define MSG_SW_OFF       (MSG_SW | 0x00)
#define MSG_SW_ON        (MSG_SW | 0x01)
#define MSG_SW_EDGE      (MSG_SW | SW_EDGE)
#define MSG_SW_QUERY     (MSG_SW | 0x04)

#define MSG_LAMP_OFF  (MSG_LAMP | 0x00)
#define MSG_LAMP_ON   (MSG_LAMP | 0x0F)

#define MSG_LGROUP_OFF    (MSG_LGROUP | 0x00)
#define MSG_LGROUP_ON     (MSG_LGROUP | 0x01)
#define MSG_LGROUP_RESET  (MSG_LGROUP | 0x03)
#define MSG_LGROUP_TOGGLE (MSG_LGROUP | 0x04)
#define MSG_LAMP_FLASH    0x77

#define MSG_SCORE_RESET (MSG_SCORE | 0x00)
#define MSG_SET_PLAYER  (MSG_SCORE | 0x01)
#define MSG_SCORE_SET   (MSG_SCORE | 0x02)
#define MSG_SCORE_ADD   (MSG_SCORE | 0x08)

#define TRACK1          0x00
#define TRACK2          0x01
#define TRACK3          0x02
#define TRACK_ALL       0x03
#define VOL_MASTER      0x03

#define CHANNEL_RIGHT    0x04
#define CHANNEL_LEFT     0x08
#define CHANNEL_BOTH     0x0C

#define MSG_VOLUME_MASTER         (MSG_VOLUME | VOL_MASTER | CHANNEL_BOTH)
#define MSG_VOLUME_MASTER_RIGHT   (MSG_VOLUME | VOL_MASTER | CHANNEL_RIGHT)
#define MSG_VOLUME_MASTER_LEFT    (MSG_VOLUME | VOL_MASTER | CHANNEL_LEFT)
#define MSG_VOLUME_TRACK1         (MSG_VOLUME | TRACK1 | CHANNEL_BOTH)
#define MSG_VOLUME_TRACK2         (MSG_VOLUME | TRACK2 | CHANNEL_BOTH)
#define MSG_VOLUME_TRACK3         (MSG_VOLUME | TRACK3 | CHANNEL_BOTH)
#define MSG_SET_SOUND_BANK        (MSG_VOLUME | 0x00);

#define MSG_PLAY_STOP      (MSG_PLAY | 0x00)
#define MSG_PLAY_ONCE      (MSG_PLAY | 0x04)
#define MSG_PLAY_NEXT      (MSG_PLAY | 0x08)
#define MSG_PLAY_REPEAT    (MSG_PLAY | 0x0C)

#define MSG_PLAY_TRACK1    (MSG_PLAY_ONCE | TRACK1)
#define MSG_PLAY_TRACK2    (MSG_PLAY_ONCE | TRACK2)
#define MSG_PLAY_TRACK3    (MSG_PLAY_ONCE | TRACK3)

#define MSG_NOP        (MSG_CTL | 0x04)
#define MSG_TIMER_SYNC (MSG_CTL | 0x05)
#define MSG_SET_MODE   (MSG_CTL | 0x06)
#define MSG_RESET_MODE (MSG_CTL | 0x07)
#define MSG_NEW_GAME   (MSG_CTL | 0x0A)
#define MSG_GAME_OVER  (MSG_CTL | 0x0B)
#define MSG_NEW_BALL   (MSG_CTL | 0x0E)
#define MSG_TILT       (MSG_CTL | 0x0F)
                      
#define COIL0_ON     COIL0 = 0;
#define COIL1_ON     COIL1 = 0;
#define COIL2_ON     COIL2 = 0;
#define COIL3_ON     COIL3 = 0;
#define COIL4_ON     COIL4 = 0;
#define COIL5_ON     COIL5 = 0;
#define COIL6_ON     COIL6 = 0;
#define COIL7_ON     COIL7 = 0;

#define COIL0_OFF    COIL0 = 1;
#define COIL1_OFF    COIL1 = 1;
#define COIL2_OFF    COIL2 = 1;
#define COIL3_OFF    COIL3 = 1;
#define COIL4_OFF    COIL4 = 1;
#define COIL5_OFF    COIL5 = 1;
#define COIL6_OFF    COIL6 = 1;
#define COIL7_OFF    COIL7 = 1;

#define ROW0_ON     COIL0 = 1;
#define ROW1_ON     COIL1 = 1;
#define ROW2_ON     COIL2 = 1;
#define ROW3_ON     COIL3 = 1;
                      
#define ROW0_OFF    COIL0 = 0;
#define ROW1_OFF    COIL1 = 0;
#define ROW2_OFF    COIL2 = 0;
#define ROW3_OFF    COIL3 = 0;

#define LAMP0_ON   LAMP0 = 1;
#define LAMP1_ON   LAMP1 = 1;
#define LAMP2_ON   LAMP2 = 1;
#define LAMP3_ON   LAMP3 = 1;
#define LAMP4_ON   LAMP4 = 1;
#define LAMP5_ON   LAMP5 = 1;
#define LAMP6_ON   LAMP6 = 1;
#define LAMP7_ON   LAMP7 = 1;

#define LAMP0_OFF  LAMP0 = 0;
#define LAMP1_OFF  LAMP1 = 0;
#define LAMP2_OFF  LAMP2 = 0;
#define LAMP3_OFF  LAMP3 = 0;
#define LAMP4_OFF  LAMP4 = 0;
#define LAMP5_OFF  LAMP5 = 0;
#define LAMP6_OFF  LAMP6 = 0;
#define LAMP7_OFF  LAMP7 = 0;

#define ROW0_ON     COIL0 = 1;
#define ROW1_ON     COIL1 = 1;
#define ROW2_ON     COIL2 = 1;
#define ROW3_ON     COIL3 = 1;
                      
#define ROW0_OFF    COIL0 = 0;
#define ROW1_OFF    COIL1 = 0;
#define ROW2_OFF    COIL2 = 0;
#define ROW3_OFF    COIL3 = 0;

#define CMD_ON          0x01
#define CMD_OFF         0x00
#define CMD_PULSE_STRONG  0x05
#define CMD_PULSE       0x03
#define CMD_PULSE_WEAK  0x02

#define PK_MODE_MODE1   0x01
#define PK_MODE_MODE2   0x02
#define PK_MODE_MODE3   0x04
#define PK_MODE_MODE4   0x08
#define PK_MODE_DIAG    0x40
#define PK_MODE_REVERSE 0x80



#define POLY 0xF1A7

#if defined(PK_SOUND)
  #define MAX_EVENTS 1
  #define MAX_EVENTS_MASK  0x01;
  #define WHEELSIZE  1
#else
  #define MAX_EVENTS          32
  #define MAX_EVENTS_MASK   0x1F;
  #define MAX_SCHED           32
  #define WHEELSIZE           64
  #define WHEELSIZE_MASK    0x3F
#endif

extern BYTE wheel[WHEELSIZE];
extern struct EVENT eventq[MAX_SCHED];

/* PinKit Controller Variables */
#if MAX_LAMPS > 0
extern struct LAMP lamp[MAX_LAMPS];
#endif

extern struct SW   sw[MAX_SWITCHES];
#if MAX_COILS > 0
extern struct COIL coil[MAX_COILS];
#endif

/* Predefine the COIL_PULSE multiplication to avoid multiply operation */
extern BYTE PULSE_LOOKUP[];
extern UINT16 BLINK_RATE[];

/* Score Reel (SR) State */
#define SR_ENABLE    0
#define SR_SYNC      1
#define SR_UNKNOWN   2
#define SR_DISABLE   3

extern BYTE player;
extern BYTE score[MAX_PLAYER][MAX_DIGITS];         /* 8 digits for each player */
extern BYTE reel[MAX_DIGITS];                      /* current score reel position */
extern BYTE reg[16];

extern BYTE num_digits;
BYTE score_reset(void);
void zero_scores(BYTE n);

void set_scores(BYTE n);

void add_score(BYTE player, BYTE value);


#define SEND_PINCAN_MSG(id, data)   while(!ECANSendMessage(id, data, 2, ECAN_TX_STD_FRAME))

/* Low priority message, 1 try only */
#define SEND_PINCAN_MSG_LP(id, data)   ECANSendMessage(id, data, 2, ECAN_TX_STD_FRAME)


UINT16 rand_lfsr(UINT16 min, UINT16 max, BYTE mask);
BYTE rand8(BYTE min, BYTE max);

int choice16(UINT16 *list, BYTE min, BYTE max);

void pinkit_init(void);

BYTE ensched_cmd(BYTE time, BYTE cmd1, BYTE cmd2);
BYTE ensched_fn(BYTE time, void (*func)(void));
/* returns the next entry from the requested time slot */

BYTE desched(BYTE time);


BYTE enqueue(BYTE cmd1, BYTE cmd2);

BYTE dequeue(BYTE *cmd1, BYTE *cmd2);
void requeue(void);


/* coil_on: Drive the PIN to turn coil n ON */
void coil_on(BYTE n);

/* coil_off: Drive the PIN to turn coil n OFF */
void coil_off(BYTE n);

/* lamp_on: Drive the PIN to turn lamp n ON */
void lamp_on(BYTE n);

/* lamp_off: Drive the PIN to turn lamp n ON */
void lamp_off(BYTE n);

void local_coil_pulse(BYTE n, BYTE dur);

#if MAX_LAMPS > 0
void lamp_group_assign(BYTE lnum, BYTE group);
void lamp_group_on(BYTE group);
void lamp_group_off(BYTE group);
void lamp_group_reset(BYTE group);
void lamp_group_toggle(BYTE group);
void set_lamp(BYTE lnum, BYTE state, BYTE pwm, BYTE blink);
#endif

#endif /*PINKIT_H*/