Merge branch 'main' of gitea.hottis.de:wn/tetris

display-driver/main.c

@@ -76,7 +76,7 @@ int main() {
   P1SEL |= BIT4 | BIT5 | BIT6 | BIT7;
   P1SEL2 |= BIT4 | BIT5 | BIT6 | BIT7;
   // most significant bit first, enable STE
-  UCB0CTL0 = UCSYNC | UCMSB | UCMODE_2;
+  UCB0CTL0 = UCCKPH | UCSYNC | UCMSB | UCMODE_2;
   UCB0CTL1 = 0x00;
   // enable RX interrupt
   UC0IE |= UCB0RXIE;

game-ctrl/Makefile

@@ -7,11 +7,11 @@ MCU=msp430g2553
 CFLAGS=-Wall -mmcu=$(MCU) -std=gnu99 -I $(TOOLCHAIN_PREFIX)/include -O1 -g0
 
 # for debugging
-#CFLAGS+= -g3 -ggdb -gdwarf-2
+CFLAGS+= -g3 -ggdb -gdwarf-2
 
 LDFLAGS=-mmcu=$(MCU) -L $(TOOLCHAIN_PREFIX)/include
 
-$(ARTIFACT).elf:	main.o spi.o scheduler.o canvas.o shapes.o game.o buttons.o myrand.o display.o sound.o
+$(ARTIFACT).elf:	main.o spi.o scheduler.o canvas.o shapes.o game.o buttons.o myrand.o display.o sound.o eeprom.o
 	$(CC) -o $@ $(LDFLAGS) $^
 	$(OBJDUMP) -D $(ARTIFACT).elf > $(ARTIFACT).txt
 

game-ctrl/buttons.c

@@ -10,6 +10,8 @@
 #include "sound.h"
 
 
+bool mutedFlag = true;
+
 static uint8_t buttonsMoveLeftPressed() {
   static uint8_t last = 0;
   uint8_t current = (P2IN & BIT4);
@@ -49,7 +51,6 @@ static uint8_t buttonsMoveDownPressed() {
 void buttonsExec(void *handle) {
   static uint32_t unmuteTimestamp;
   uint32_t currentTimestamp = getSeconds();
-  static bool mutedFlag = true;
 
 
   if (! stoneIsValid()) {
@@ -107,3 +108,7 @@ void buttonsInit() {
   schAdd(buttonsExec, NULL, 0, 25);
 }
 
+bool isGameActive() {
+  return ! mutedFlag;
+}
+

game-ctrl/buttons.h

@@ -1,7 +1,10 @@
 #ifndef _BUTTONS_H_
 #define _BUTTONS_H_
 
+#include <stdbool.h>
+
 void buttonsInit();
+bool isGameActive();
 
 
 #endif // _BUTTONS_H_

game-ctrl/eeprom.c

@@ -0,0 +1,75 @@
+#include <stdint.h>
+#include "eeprom.h"
+#include "spi.h"
+
+
+#define MAGIC 0xaffe
+#define HIGHSCORE_ADDR 0x00
+#define DUMMY 0x00
+#define CMD_READ  0b00000011
+#define CMD_WRITE 0b00000010
+#define CMD_WRDI  0b00000100
+#define CMD_WREN  0b00000110
+
+
+typedef union {
+  uint8_t buffer[4];
+  struct {
+    uint16_t magic;
+    uint16_t highScore;
+  } v;
+} eepromBuf_t;
+
+eepromBuf_t buf;
+
+static void writeBuf() {
+  spiSendBegin(e_SPI_EEPROM);
+  spiSendOctet(CMD_WREN);
+  spiSendEnd(e_SPI_EEPROM);
+
+  spiSendBegin(e_SPI_EEPROM);
+  spiSendOctet(CMD_WRITE);
+  spiSendOctet(HIGHSCORE_ADDR);
+  spiSendOctet(buf.buffer[0]);
+  spiSendOctet(buf.buffer[1]);
+  spiSendOctet(buf.buffer[2]);
+  spiSendOctet(buf.buffer[3]);
+  spiSendEnd(e_SPI_EEPROM);
+}
+
+static void readBuf() {
+  spiSendBegin(e_SPI_EEPROM);
+  spiSendOctet(CMD_READ);
+  spiReceiveOctet();
+  spiSendOctet(HIGHSCORE_ADDR);
+  spiReceiveOctet();
+  spiSendOctet(DUMMY);
+  buf.buffer[0] = spiReceiveOctet();
+  spiSendOctet(DUMMY);
+  buf.buffer[1] = spiReceiveOctet();
+  spiSendOctet(DUMMY);
+  buf.buffer[2] = spiReceiveOctet();
+  spiSendOctet(DUMMY);
+  buf.buffer[3] = spiReceiveOctet();
+  spiSendEnd(e_SPI_EEPROM);
+}
+
+void eepromInit() {
+  readBuf();
+
+  if (buf.v.magic != MAGIC) {
+    buf.v.magic = MAGIC;
+    buf.v.highScore = 0;
+    writeBuf();
+  }
+}
+
+uint16_t eepromReadHighScore() {
+  return buf.v.highScore;
+}
+
+void eepromWriteHighScore(uint16_t v) {
+  buf.v.highScore = v;
+  writeBuf();
+}
+

game-ctrl/eeprom.h

@@ -0,0 +1,13 @@
+#ifndef _EEPROM_H_
+#define _EEPROM_H_
+
+#include <stdint.h>
+
+
+void eepromInit();
+uint16_t eepromReadHighScore();
+void eepromWriteHighScore(uint16_t v);
+
+
+
+#endif // _EEPROM_H_

game-ctrl/game.c

@@ -8,6 +8,8 @@
 #include "../rgb-driver/colors.h"
 #include "display.h"
 #include "sound.h"
+#include "eeprom.h"
+#include "buttons.h"
 
 
 #define GAME_CYCLE_TIME 100
@@ -35,6 +37,7 @@ void gameExec(void *handle) {
   static uint8_t proceedDelay;
   static uint8_t level;
   static uint16_t score;
+  static bool newHighScoreAchieved;
 
 // --- engine begin -------------------------------------------------------
   switch (state) {
@@ -44,7 +47,7 @@ void gameExec(void *handle) {
       soundCtrl(SOUND_START);
       level = 1;
       score = 0;
-      displaySetValue(score);
+      newHighScoreAchieved = false;
       phase = e_Phase_Game;
       state = e_NewStone;
       break;
@@ -91,7 +94,7 @@ void gameExec(void *handle) {
 
     case e_GameOverFill:
       rowIndex--;
-      canvasFillRow(rowIndex, _red);
+      canvasFillRow(rowIndex, newHighScoreAchieved ? _green : _red);
       if (rowIndex == 0) {
         state = e_GameOverWipe;
       }
@@ -121,6 +124,10 @@ void gameExec(void *handle) {
     for (uint8_t r = 0; r < CANVAS_HEIGHT; r++) {
       if (canvasIsRowFilled(r)) {
         score += level;
+        if (score > eepromReadHighScore()) {
+          newHighScoreAchieved = true;
+          eepromWriteHighScore(score);
+        }
         displaySetValue(score);
         canvasWipeRow(r);
         canvasShow();
@@ -131,6 +138,12 @@ void gameExec(void *handle) {
       soundCtrl(SOUND_FANFARE); 
     }
   }
+
+  if (isGameActive()) {
+    displaySetValue(score);
+  } else {
+    displaySetValue(eepromReadHighScore());
+  }
 }
 
 void gameInit() {

game-ctrl/main.c

@@ -12,6 +12,7 @@
 #include "myrand.h"
 #include "spi.h"
 #include "display.h"
+#include "eeprom.h"
 
 
 int main() {
@@ -28,6 +29,7 @@ int main() {
     schInit();
 
     spiInit();
+    eepromInit();
     displayInit();
     myRandInit();
     canvasInit();

game-ctrl/spi.c

@@ -3,7 +3,7 @@
 
 void spiInit() {
   // SPI in master mode, most significant bit first
-  UCB0CTL0 = UCMST | UCMSB;
+  UCB0CTL0 = UCCKPH | UCMST | UCMSB;
   // SPI timing config
   UCB0CTL1 = UCSSEL_3;
   // Faster than 8 ends up in strange communication errors
@@ -19,25 +19,25 @@ void spiInit() {
   // BIT7: UCB0SIMO
   P1SEL |= BIT5 | BIT6 | BIT7;
   P1SEL2 |= BIT5 | BIT6 | BIT7;
-  P1DIR |= BIT5 | BIT7;
+  // P1DIR |= BIT5 | BIT7;
 
-  // Device Select Lines: 0: Canvas, 1: Display, 2: Sound
-  P1DIR |= BIT0 | BIT1 | BIT2;
+  // Device Select Lines: 0: Canvas, 1: Display, 2: Sound, 4: EEPROM
+  P1DIR |= BIT0 | BIT1 | BIT2 | BIT4;
   // Disable all of them
-  P1OUT |= BIT0 | BIT1 | BIT2;
+  P1OUT |= BIT0 | BIT1 | BIT2 | BIT4;
 
   // enable SPI module
   UCB0CTL1 &= ~UCSWRST;
 }
 
 void spiSendBegin(t_SpiDeviceSelector d) {
-  uint16_t bit = ((uint16_t[]){ BIT0, BIT1, BIT2 })[d];
+  uint16_t bit = ((uint16_t[]){ BIT0, BIT1, BIT2, BIT4 })[d];
   P1OUT &= ~bit;
 }
 
 void spiSendEnd(t_SpiDeviceSelector d) {
   while (UCB0STAT & UCBUSY);
-  uint16_t bit = ((uint16_t[]){ BIT0, BIT1, BIT2 })[d];
+  uint16_t bit = ((uint16_t[]){ BIT0, BIT1, BIT2, BIT4 })[d];
   P1OUT |= bit;
 }
 
@@ -48,3 +48,9 @@ void spiSendOctet(uint8_t v) {
   UCB0TXBUF = v;
 }
 
+uint8_t spiReceiveOctet() {
+  while (!(UC0IFG & UCB0RXIFG));
+  uint8_t v = UCB0RXBUF;
+  return v;
+}
+

game-ctrl/spi.h

@@ -4,12 +4,13 @@
 #include <stdint.h>
 
 
-typedef enum { e_SPI_CANVAS, e_SPI_DISPLAY, e_SPI_SOUND } t_SpiDeviceSelector;
+typedef enum { e_SPI_CANVAS, e_SPI_DISPLAY, e_SPI_SOUND, e_SPI_EEPROM } t_SpiDeviceSelector;
 
 void spiInit();
 void spiSendBegin(t_SpiDeviceSelector d);
 void spiSendEnd(t_SpiDeviceSelector d);
 void spiSendOctet(uint8_t v); 
+uint8_t spiReceiveOctet();
 
 
 

readme.md

@@ -0,0 +1,43 @@
+# Tetris - Hardware and Software
+
+This Tetris implementation consists of a hardware and a software (running on that hardware).
+
+The hardware utilizes four MSP430 microcontrollers for 1.) the game play, 2.) the play ground canvas, 3.) the score display and 4.) the sound effects.
+
+## Game Play
+
+Code is in subdir `game-ctrl` (https://gitea.hottis.de/wn/tetris/src/branch/main/game-ctrl).
+
+In the firmware for this MSP430 microcontroller the whole game mechanics, reading the buttons, reading and writing the highscore EEPROM  and the control of the peripherial microcontrollers are implemented.
+
+The buttons are debounced using RC circuitry and Schmitt triggers and connected to GPIOs of the microcontroller.
+
+The peripherial microcontrollers and the EEPROM are connected via SPI including individual chip select lines.
+
+## Play Ground Canvas
+
+Code is in subdir `rgb-driver` (https://gitea.hottis.de/wn/tetris/src/branch/main/rgb-driver).
+
+The play ground is implemented using a 10 * 20 matrix of PL9823 RGB LEDs which are controlled by another MSP430 microcontroller. The firmware for this microcontroller is implemented for performance and real time requirements in assembly code. Through some discret logic the signals for PL9823 LEDs are generated. Major challenge was to generated the signals according the datasheet of all 200 (including a mini canvas for the stone preview: 212) LEDs in real time without interrupts.
+
+The communcation with the game play controller is implemented as a sequences of tuples of LED address (0 to 211) and color code. A single octet of 253 where the LED address is expected is taken as the end-of-telegram mark. Readiness to receive a telegram is signaled to the game play controller via a single line connected to a GPIO of the game play controller.
+
+## Score Display
+
+Code is in subdir `display-driver` (https://gitea.hottis.de/wn/tetris/src/branch/main/display-driver).
+
+In the first place, a MAX7221 was meant to be used for connecting a multiple digit seven-segment display. However, it appears, that the MAX7221 requires 3.5V as minimum voltage for the high-level, which caan't be provided by the MSP430 (which runs on 3.3V) and level-shifters haven't been around. Thus, the minimal required amount of functionality of the MAX7221 has been implemented in C on an MSP430. Just four digits are supported. 
+
+Communication with the game play controller is just a 16 bit number to be displayed.
+
+## Sound Effects
+
+Code is in subdir `sound-driver` (https://gitea.hottis.de/wn/tetris/src/branch/main/sound-driver).
+
+An MSP430 microcontroller and two mediaeval AY-3-8913 sound chips are deployed. The sound chips themselve run on 5V, their 8-bit-address/data bus is connected to the port 2 (bit 0 to 7) of the microcontroller. The bus control signal `_CS`, `BC1` and `BDIR` are generated in software and provided via GPIOs.
+
+An amplifier following the proposal of the AY-3-8913 datasheet is implemented using a LM386 chip. A MOSFET BS108 controlled via a GPIO is use the shortcut the input of the amplifier to ground to mute sound effects.
+
+The clock generator proposed by the AY-3-8913 does not work reliably, so an alternative design from "The Art of Electronics" has been used.
+
+

rgb-driver/main.S

@@ -123,7 +123,7 @@ init:
 
   ;; spi configuration
   ;;  USCI B to slave mode, enable STE and most significant bit first
-  mov.b   #UCSYNC|UCMODE_2|UCMSB, &UCB0CTL0
+  mov.b   #UCCKPH|UCSYNC|UCMODE_2|UCMSB, &UCB0CTL0
   mov.b   #0x00, &UCB0CTL1
 
   ;; make sure the isr will not immediately start

sound-driver/spi_init.c

@@ -18,7 +18,7 @@ void spiInit() {
   P1SEL2 |= BIT4 | BIT5 | BIT7;
 
   // most significant bit first, enable STE
-  UCB0CTL0 = UCSYNC | UCMSB | UCMODE_2;
+  UCB0CTL0 = UCCKPH | UCSYNC | UCMSB | UCMODE_2;
   UCB0CTL1 = 0x00;
 
   // enable RX interrupt