gamepad.c

/*
* Copyright Jacques Deschênes 2019 
* This file is part of BP_CHIPCON.
*
*     BP_CHIPCON 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.
*
*     BP_CHIPCON 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 for more details.
*
*     You should have received a copy of the GNU General Public License
*     along with BP_CHIPCON.  If not, see <http:https://www.gnu.org/licenses/>.
*/


/*  
 *  Date création: 2019-05-22
 *  Interface game pad
 *  NOTES:
 *  1) le COSMAC VIP utilisait un clavier hexadécimal
 *     et ce gamepad n'a que 8 boutons. Pour faire fonctionner
 *     des jeux pré-existants sur cette machine il faut créer une
 *     correspondance entre les touches du gamepad et le clavier hexadécimal
 *     utilisé dans le jeux. C'est le rôle de la table buttons[8].
 *  
*/

#include "gamepad.h"
#include "tvout.h"

#define GAMEPAD_PORT PORTB
#define CLK_PIN (13)
#define MOSI_PIN  (14)
#define MISO_PIN (15)

volatile uint8_t  btn_state;


// valeurs hexadécimal des boutons 
// les entrées correspondes à la position du bitmask du bouton
// i.e.  le bouton BTN_A est à la position 0 dans la table et le
// bouton BTN_UP  est à la position 7 dans la table.
const uint8_t default_kmap[8]={KEY_A,KEY_C,KEY_B,KEY_D,KEY_RIGHT,KEY_DOWN,KEY_LEFT,KEY_UP};
static uint8_t buttons[8];

// retourne l'index du bouton dans la table buttons[]
// à partir de sont bitmask
// input:
//      mask masque binaire du bouton
// output:
//      idx  index dans la table
static uint8_t btn_idx(uint8_t mask){
    uint8_t idx=0;
    mask>>=1;
    while(mask){idx++; mask>>=1;}
    return idx;
}

// retourne la mask du bouton à partir de sa valeur hexadécimal
// input:
//      btn_value   valeur hexadécimal du bouton inscrite dans la table buttons[]
// output:
//      mask   retourne le masque de bit, si trouvé dans la table sinon retourne 255.
static uint8_t btn_mask(uint8_t btn_value){
    int i;
    for (i=0;i<8;i++){
        if (buttons[i]==btn_value) return 1<<i;
    }
    return 255;
}

// set buttons map
void set_keymap(const uint8_t *kmap){
    int i;
    for (i=0;i<8;i++) buttons[i]=kmap[i];
}

// initialisation matérielle.
void gamepad_init(){
    config_pin(GAMEPAD_PORT,MOSI_PIN,OUTPUT_PP_SLOW);
    config_pin(GAMEPAD_PORT,CLK_PIN,OUTPUT_PP_SLOW);
//    config_pin(GAMEPAD_PORT,MISO_PIN,INPUT_PULL);
    btn_state=0xff;
    set_keymap(default_kmap);
}

static int count_zeros(uint8_t u8){
    int count=0;
    while (u8){
        if (!(u8&1)) count++;
        u8>>=1;
    }
    return count;
}

static uint8_t shift_out(uint8_t byte){
    uint8_t mask=1,rx_byte=0;

#define _clk_delay()  asm volatile("nop\n\tnop\n\tnop\n\t")

    while (mask){
        if (byte&mask){
            GAMEPAD_PORT->ODR|=(1<<MOSI_PIN);
        }else{
            GAMEPAD_PORT->ODR&=~(1<<MOSI_PIN);
        }
        GAMEPAD_PORT->ODR|=(1<<CLK_PIN);
        _clk_delay();
        GAMEPAD_PORT->ODR&=~(1<<CLK_PIN);
        rx_byte>>=1;
        if (GAMEPAD_PORT->IDR&(1<<MISO_PIN)) rx_byte|=128;    
        mask<<=1;
    }
    GAMEPAD_PORT->ODR|=(1<<MOSI_PIN);
    GAMEPAD_PORT->ODR|=(1<<CLK_PIN);
    _clk_delay();
    GAMEPAD_PORT->ODR&=~(1<<CLK_PIN);
    return rx_byte;
}

// lecture du gamepad
// cette fonction est appellée
// à partir de TV_SYNC_handler()
void read_gamepad(){
    btn_state=shift_out(0xfe);
    if ((btn_state&(BTN_RIGHT_MASK|BTN_C_MASK))==0){
        while (btn_state!=0xff){
            btn_state=shift_out(0xfe);
        };
        _reset_mcu();
    }
}

// véririfie si le bouton est enfoncé.
// input:
//    button  bouton à vérifier.
//  output:
//      1->bouton enfoncé, 0->relâché.
int btn_query_down(uint8_t btn){
    uint8_t mask=btn_mask(btn);
    return !(btn_state&mask);
}

// attend qu'un bouton soit enfoncé.
// pour être reconnu un bouton doit
// demeuré enfoncé pour 3 frames vidéo consécutifs.
//  input:
//      button  le bouton à vérifier
//  output:
//      
void btn_wait_down(uint8_t btn){
    uint8_t mask=btn_mask(btn);
    int frame_count=0;
    while (frame_count<3){
        frame_sync();
        if (!(btn_state&mask)){
            frame_count++;
        }else{
            frame_count=0;
        }
    }
}

// attend qu'un bouton soit relâché.
//  pour être reconnu comme relâché un
//  bouton doit-être relâché 3 frame vidéo consécutifs.
//  input:
//      button  le bouton à vérifier
//  output:
//      
void btn_wait_up(uint8_t btn){
    uint8_t mask=btn_mask(btn);
    int frame_count=0;
    while (frame_count<3){
        frame_sync();
        if ((btn_state&mask)){
            frame_count++;
        }else{
            frame_count=0;
        }
    }
}


// attend qu'au moins un bouton soit enfoncé.
// pour être reconnu comme enfoncé un bouton doit 
// le demeuré pour 3 frame vidéo consécutif.
//  input:
//  
//  output:
//      État de tous les boutons, bit à 0->relâché, bit à 1->enfoncé
uint8_t btn_wait_any(){
    uint8_t btn, last_state=btn_state;
    int frame_count=0;
    while (frame_count<3){
        frame_sync();
        if (last_state!=btn_state){
            frame_count=0;
            last_state=btn_state;
        }else if(btn_state!=0xff){
            frame_count++;
        }       
    }
    btn=buttons[btn_idx(last_state^0xff)];
    // wait button release
    btn_wait_up(btn);
    return btn;
}

// modifie la transcription d'un bouton
// input:
//      btn   index dans la table {0..7}
void btn_set_value(uint8_t idx,uint8_t value){
    buttons[idx]=value;
}

// retourne la table buttons
uint8_t* get_keymap(){
    return buttons;
}

// wait for any button to be down
uint8_t btn_any_down(){
    while (btn_state==0xff);
    return buttons[btn_idx(btn_state^0xff)];
    
}