/* pictalk690.c  PICTalker program for 16F690 on PK2 Starterkit */
/*      "Low pin count demo board"             J1      ________
           ___________  ___________           1 RA5---|XTAL    |
          |           \/           |          2 RA4---|14.7456 |
    +5V---|Vdd      16F690      Vss|---GND    3 RA3   |________|
     |X|--|RA5/CLKIN  RA0/AN0/(PGD)|          4 RC5->-PWM Speach
     |X|--|RA4/CLKOUT     RA1/(PGC)|          5 RC4   LP-filter
    SW1->-|RA3/!MCLR/(Vpp)  RA2/INT|          6 RC3
 Speach-<-|RC5/CCP              RC0|->-LED    7 RA0
 PWM      |RC4                  RC1|          8 RA1
          |RC3                  RC2|          9 RA2
          |RC6              RB4/SDA|-<-I2C   10 RC0
          |RC7               RB5/Rx|         11 RC1
          |RB7/Tx           RB6/SCL|->-I2C   12 RC2
          |________________________|         13 +5V--- 
                                             14 GND---
*/
/* On mini Breadboard
  I2C EEPROM with allophones - 2k pullup on SDA
        ___  ___
       |   \/   |
 GND---|A0   Vcc|---+5V
 GND---|A1    WP|---+5V
 GND---|A2   SCL|-<-RB6/SCL
 GND---|GND  SDA|->-RB4/SDA
       |________|
  PWM LP-filter. RC-ladder: 4k7, 10n, 4k7, 10n 
*/

/* B Knudsen Cc5x C-compiler - not ANSI-C */
#include "16F690.h"
#include "int16Cxx.h"
#pragma config |= 0x00D2  /* use HS-XTAL 14.7456 MHz */

/* function prototypes */
void ack_polling(void);
void start(void);
void stop(void);
char read_byte(void);
void send_byte(char);
char read_eeprom(char, char);
void write_eeprom(char, char, char);
char phonemestart_hi(char);
char phonemestart_lo(char);
char sentence(char);

/* Global variables */
char message[61];  // must be long enough for the message
char mode;
char index;
char phoneme;
unsigned long count;

#pragma origin 4
/* interrupt routine                      */
/* TIMER2 is servoupdating PWM at 7200 Hz */
interrupt int_server( void ) 
{
  int_save_registers
  char sv_FSR = FSR;       // save FSR
  char sv_PCLATH = PCLATH; // save PCLATH
  /* mode=0 => wait, ready to talk        */
  /* mode=1 => get next phoneme or pause  */
  /* mode=2 => initiate for pause         */
  /* mode=3 => initiate for phoneme       */
  /* mode=4 => go on with the pause       */
  /* mode=5 => go on with the phoneme     */
 
  char pwm_byte, address_hi, address_lo;
  pwm_byte = 128; // idle value

  switch(mode)
    {
       case 0: // wait for talk
        {
          index = 0;
          break;
        }

       case 1: // get new phoneme or pause
        phoneme = message[index];
        index++;  // phoneme is read, so update the index

        if(phoneme == 0xFF) // 0xFF means end of message
          {
            index = 0;
            mode = 0;
            break;
          }

        if(phoneme < 5) // means it is a pause
           {            
             mode = 2;
             break;
           }
 
        /* so it must be a phoneme  */
             mode = 3;
             break;          

       case 2: // initiate pause
        if(phoneme == 0) count = 72;   //  10 ms
        if(phoneme == 1) count = 216;  //  30 ms
        if(phoneme == 2) count = 360;  //  50 ms
        if(phoneme == 3) count = 720;  // 100 ms
        if(phoneme == 4) count = 1440; // 200 ms
        mode = 4; // next time, go on with the pause
        break;

       case 3: // initiate phoneme
        /* Random address read */
        address_hi = phonemestart_hi(phoneme-5);
        address_lo = phonemestart_lo(phoneme-5);
        pwm_byte = read_eeprom(address_hi, address_lo);
        mode = 5; // next time, go on with the phoneme
        break;

       case 4: //  go on with pause
        count--;
        if(count==0) mode = 1; // next time new phoneme/pause
        break;

       case 5: // go on with phoneme
        /* Current adress read, automatic increment */
        start();
        send_byte(0xA1);
        pwm_byte = read_byte(); // phoneme data
        stop();
        if(pwm_byte == 0) // means end of phoneme data
         {
           mode = 1; // next time new phoneme/pause
           pwm_byte = 128;
         }
        break;
    }

  /* update PWM  */
  CCP1CON.4 = pwm_byte.0;
  CCP1CON.5 = pwm_byte.1;
  pwm_byte /= 4;
  CCPR1L = pwm_byte; 

  /* return from the interrupt */
  TMR2IF = 0; 
  PCLATH = sv_PCLATH;    // restore PCLATH
  FSR = sv_FSR;          // restore FSR
  int_restore_registers
}


void main()
{
    char i;
    ANSELH  = 0 ; // PORTB digital
    PORTB.4 = 0 ; // PORTB.4 pending "0" 
    TRISB.4 = 1 ; // simulated open collector
    TRISB.6 = 0 ; // SCL output 
    TRISC.5 = 0 ; // CCP PWM output
    TRISC.0 = 0 ; // LED on when talking
    TRISA.3 = 1 ; // SW1 input

    /* Setup TIMER2 */
    /*
    0.xxxx.x.xx  - unimplemented
    x.1000.x.xx  Postscaler 8
    x.xxxx.1.xx  TMR2 is on
    x.xxxx.x.00  Prescaler 1
    */
    T2CON = 0b0.1000.1.00;

    /* Setup CCP1 PWM-mode  */ 
    /*
    00.xx.xxxx  Single PWM output
    xx.00.xxxx  PWM Duty Two LSB
    xx.xx.1100  11xx when Single PWM-mode
    */
    CCP1CON = 0b00.00.1100 ; 

    PR2 = 0x3F; // gives the highest PWM frequency for 8 bit resolution

    mode = 0;   // no talking yet

    TMR2IE  = 1;   /* local enable  */
    PEIE    = 1;   /* peripherals enable */
    GIE     = 1;   /* global enable */

    /* load a sentence in the message buffer */
    char ch;
    for(i=0;;i++)
     {
       ch=sentence(i);
       message[i]=ch;
       if(ch==0xFF)break;  
     }

    index =0;  
    mode = 1; // OK, now we start talking

    while(1)
      {
         if(mode !=0) PORTC.0 = 1; // LED on when talking
         else PORTC.0 = 0;
         if(PORTA.3 == 0 && mode == 0) mode = 1; // SW1 talk again
      }     
}









/* ************************************************* */
/*                    FUNCTIONS                      */
/* ************************************************* */

/* sentence.c                                    */
/* lookup table for sentence                     */
/* opcodes are for the chip SP256                */
/* the code "0xFF" is used as "end of sentence"  */

/* "we speak not only to be heard but to be understood" */
char sentence( char index)
      {
        skip(index);
        return 0x2E;
        return 0x13;
        return 0x03;
        return 0x02;
        return 0x37;
        return 0x09;
        return 0x13;
        return 0x29;
        return 0x03;
        return 0x02;
        return 0x38;
        return 0x17;
        return 0x0D;
        return 0x03;
        return 0x02;
        return 0x35;
        return 0x0B;
        return 0x2D;
        return 0x13;
        return 0x03;
        return 0x02;
        return 0x0D;
        return 0x1F;
        return 0x03;
        return 0x02;
        return 0x3F;
        return 0x13;
        return 0x03;
        return 0x02;
        return 0x1B;
        return 0x34;
        return 0x15;
        return 0x03;
        return 0x02;
        return 0x3F;
        return 0x0F;
        return 0x0D;
        return 0x03;
        return 0x02;
        return 0x0D;
        return 0x1F;
        return 0x03;
        return 0x02;
        return 0x3F;
        return 0x13;
        return 0x03;
        return 0x02;
        return 0x0F;
        return 0x0B;
        return 0x00;
        return 0x21;
        return 0x34;
        return 0x37;
        return 0x0D;
        return 0x1F;
        return 0x15;
        return 0x03;
        return 0x02;
        return 0xFF;
      }








/*
    I2C interface for 24LC512    

    Nathan Seidle
    nathan.seidle@colorado.edu
    
    minor changes by William Sandqvist
    to work with the pictalk.c program
    william@kth.se   
*/

/* The extra nop()'s are needed if compiled with optimization */

//=================
//Make sure the bits agree with the TRISB statements
#pragma bit scl_IIC @ PORTB.6
#pragma bit sda_IIC @ PORTB.4
#define  WRITE_sda() TRISB.4 = 0 // SDA must be output when writing
#define  READ_sda()  TRISB.4 = 1 // SDA must be input when reading

//=================

void ack_polling(void);
void start(void);
void stop(void);
char read_byte(void);
void send_byte(char);
char read_eeprom(char, char);
void write_eeprom(char, char, char);

void ack_polling(void)
{
    //wait for chip to respond
    //cycles 17 times to complete
    //write cycle at 4MHz
    while(sda_IIC != 0)
    {
        start();
        send_byte(0xA0);
    }
    stop();
}

void write_eeprom(char address_hi, char address_lo, char data)
{
    start();
    send_byte(0xA0);
    send_byte(address_hi);
    send_byte(address_lo);
    send_byte(data);
    stop();
}

char read_eeprom(char address_hi, char address_lo)
{
   
    char byte;

    start();
    send_byte(0xA0); // control byte = write
    send_byte(address_hi);
    send_byte(address_lo);
    stop();

    start();
    send_byte(0xA1); // control byte = read
    byte = read_byte();
    stop();
    
    return byte;
}

void start(void)
{
    WRITE_sda();
    sda_IIC = 0;
}

void stop(void)
{
    scl_IIC = 0;

    WRITE_sda();
    sda_IIC = 0;
    // nop();
    // nop(); 
    nop();
    nop();
    scl_IIC = 1;
    // nop();
    // nop(); 
    nop();
    sda_IIC = 1;
}

char read_byte(void)
{
    char j, in_byte;

    scl_IIC = 0;

    READ_sda();

    for(j = 0 ; j < 8 ; j++)
    {
        scl_IIC = 0;
        // nop();
        // nop();
        // nop();
        nop();
        scl_IIC = 1;

        in_byte = rl(in_byte);
        in_byte.0 = sda_IIC;
    }

    return in_byte;
}

void send_byte(char out_byte)
{
    char i;

    WRITE_sda();

    for( i = 0 ; i < 8 ; i++ )
    {
        out_byte = rl(out_byte);
        scl_IIC = 0;
        sda_IIC = Carry;
        scl_IIC = 1;
        nop();
    }

    //read ack.
    scl_IIC = 0;
    READ_sda();
    scl_IIC = 1;
}







/* lookup tables for allphone start adresses in the I2C-EEPROM        */
/* all allphone data ends with "0" in the I2C-EEPROM                  */
/* pauses 0x00, 0x01, 0x02, 0x03, 0x04 are not stored in EEPROM       */
/* so opcodes for SP256 with the offset of -5 should be used as index */

char phonemestart_hi(char index)
{
  skip(index);
  return 0x00; // 0x05  OY  as in vOIce
  return 0x09; // 0x06  AY  as in kIte
  return 0x0E; // 0x07  EH  as in End
  return 0x10; // 0x08  KK3 as in Crane
  return 0x13; // 0x09  PP  as in Pow
  return 0x18; // 0x0A  JH  as in JudGe
  return 0x1B; // 0x0B  NN1 as in thiN
  return 0x21; // 0x0C  IH  as in sIt
  return 0x23; // 0x0D  TT2 as in To
  return 0x26; // 0x0E  RR1 as in Read
  return 0x2B; // 0x0F  AX  as in sUceed
  return 0x2D; // 0x10  MM  as in ilk
  return 0x33; // 0x11  TT1 as in parTs
  return 0x36; // 0x12  DH1 as in THis
  return 0x3A; // 0x13  IY  as in sEE
  return 0x40; // 0x14  EY  as in trAY
  return 0x46; // 0x15  DD1 as in enD
  return 0x48; // 0x16  UW1 as in tO
  return 0x4B; // 0x17  AO  as in AUght
  return 0x4E; // 0x18  AA  as in hOt
  return 0x51; // 0x19  YY2 as in Yes
  return 0x56; // 0x1A  AE  as in hAt
  return 0x59; // 0x1B  HH1 as in He
  return 0x5C; // 0x1C  BB1 as in riB
  return 0x5E; // 0x1D  TH  as in THin
  return 0x62; // 0x1E  UH  as in bOOk
  return 0x65; // 0x1F  UW2 as in fOOd
  return 0x6A; // 0x20  AW  as in dOWn
  return 0x72; // 0x21  DD2 as in Down
  return 0x74; // 0x22  GG3 as in peG
  return 0x78; // 0x23  VV  as in Vest
  return 0x7C; // 0x24  GG1 as in Guest
  return 0x7E; // 0x25  SH  as in SHip
  return 0x85; // 0x26  ZH  as in pleaSure
  return 0x89; // 0x27  RR2 as in cRane
  return 0x8D; // 0x28  FF  as in Food
  return 0x90; // 0x29  KK2 as in speaK 
  return 0x95; // 0x2A  KK1 as in Can't
  return 0x99; // 0x2B  ZZ  as in Zoo
  return 0x9D; // 0x2C  NG  as in aNGer
  return 0xA4; // 0x2D  LL  as in Like
  return 0xA6; // 0x2E  WW  as in We
  return 0xAB; // 0x2F  XR  as in stARs
  return 0xB2; // 0x30  WH  as in WHig
  return 0xB8; // 0x31  YY1 as in cUte
  return 0xBB; // 0x32  CH  as in CHurCH
  return 0xBF; // 0x33  ER1 as in lettER
  return 0xC3; // 0x34  ER2 as in fERn
  return 0xCA; // 0x35  OW  as in zOne
  return 0xCF; // 0x36  DH2 as in baTHe
  return 0xD4; // 0x37  SS  as in veSt
  return 0xD7; // 0x38  NN2 as in No
  return 0xDB; // 0x39  HH2 as in Hoe
  return 0xDF; // 0x3A  OR  as in fORtune
  return 0xE6; // 0x3B  AR  as in alARm
  return 0xED; // 0x3C  YR  as in hEAr
  return 0xF4; // 0x3D  GG2 as in Got
  return 0xF6; // 0x3E  EL  as in angLE
  return 0xFB; // 0x3F  BB2 as in Beast
}

char phonemestart_lo(char index)
{
  skip(index);
  return 0x06; // 0x05  OY  as in vOIce
  return 0x00; // 0x06  AY  as in kIte
  return 0x80; // 0x07  EH  as in End
  return 0xC0; // 0x08  KK3 as in Crane
  return 0x80; // 0x09  PP  as in Pow
  return 0x40; // 0x0A  JH  as in udGe
  return 0xC0; // 0x0B  NN1 as in thiN
  return 0x40; // 0x0C  IH  as in sIt
  return 0x00; // 0x0D  TT2 as in To
  return 0x40; // 0x0E  RR1 as in Read
  return 0x40; // 0x0F  AX  as in sUceed
  return 0xC0; // 0x10  MM  as in Milk
  return 0x80; // 0x11  TT1 as in arTs
  return 0x40; // 0x12  DH1 as in THis
  return 0xC0; // 0x13  IY  as in sEE
  return 0x40; // 0x14  EY  as in trAY
  return 0x80; // 0x15  DD1 as in enD
  return 0x40; // 0x16  UW1 as in tO
  return 0x00; // 0x17  AO  as in AUght
  return 0x80; // 0x18  AA  as in hOt
  return 0xC0; // 0x19  YY2 as in Yes
  return 0x40; // 0x1A  AE  as in hAt
  return 0x80; // 0x1B  HH1 as in He
  return 0x80; // 0x1C  BB1 as in riB
  return 0x00; // 0x1D  TH  as in THin
  return 0x40; // 0x1E  UH  as in bOOk
  return 0x00; // 0x1F  UW2 as in fOOd
  return 0x80; // 0x20  AW  as in dOWn
  return 0x40; // 0x21  DD2 as in Down
  return 0xC0; // 0x22  GG3 as in peG
  return 0x40; // 0x23  VV  as in Vest
  return 0x40; // 0x24  GG1 as in Guest
  return 0xC0; // 0x25  SH  as in SHip
  return 0x00; // 0x26  ZH  as in pleaSure
  return 0x80; // 0x27  RR2 as in cRane
  return 0x40; // 0x28  FF  as in Food
  return 0xC0; // 0x29  KK2 as in speaK 
  return 0x40; // 0x2A  KK1 as in Can't
  return 0x00; // 0x2B  ZZ  as in Zoo
  return 0xC0; // 0x2C  NG  as in aNGer
  return 0x00; // 0x2D  LL  as in Like
  return 0xC0; // 0x2E  WW  as in We
  return 0x40; // 0x2F  XR  as in stARs
  return 0xC0; // 0x30  WH  as in WHig
  return 0x00; // 0x31  YY1 as in cUte
  return 0x00; // 0x32  CH  as in CHurCH
  return 0xC0; // 0x33  ER1 as in lettER
  return 0x80; // 0x34  ER2 as in fERn
  return 0x00; // 0x35  OW  as in zOne
  return 0x40; // 0x36  DH2 as in baTHe
  return 0xC0; // 0x37  SS  as in veSt
  return 0x00; // 0x38  NN2 as in No
  return 0x80; // 0x39  HH2 as in Hoe
  return 0x80; // 0x3A  OR  as in fORtune
  return 0xC0; // 0x3B  AR  as in alARm
  return 0x00; // 0x3C  YR  as in hEAr
  return 0x80; // 0x3D  GG2 as in Got
  return 0xC0; // 0x3E  EL  as in angLE
  return 0x00; // 0x3F  BB2 as in Beast
}