ps2controller.h

Go to the documentation of this file.

/*
  Created by Fabrizio Di Vittorio (fdivitto2013@gmail.com) - <http://www.fabgl.com>
  Copyright (c) 2019-2022 Fabrizio Di Vittorio.
  All rights reserved.
 
 
* Please contact fdivitto2013@gmail.com if you need a commercial license.
 
 
* This library and related software is available under GPL v3.
 
  FabGL 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.
 
  FabGL 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 FabGL.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 
#pragma once
 
 
 
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "freertos/timers.h"
 
#include "fabutils.h"
#include "fabglconf.h"
 
 
namespace fabgl {
 
 
enum class PS2Preset {
  KeyboardPort0_MousePort1,   
  KeyboardPort1_MousePort0,   
  KeyboardPort0,              
  KeyboardPort1,              
  MousePort0,                 
  MousePort1,                 
};
 
 
enum class KbdMode {
  NoVirtualKeys,           
  GenerateVirtualKeys,     
  CreateVirtualKeysQueue,  
};
 
 
class Keyboard;
class Mouse;
 
 
class PS2Controller {
 
public:
 
  PS2Controller();
  ~PS2Controller();
 
  // unwanted methods
  PS2Controller(PS2Controller const&)   = delete;
  void operator=(PS2Controller const&)  = delete;
 
  static void begin(gpio_num_t port0_clkGPIO, gpio_num_t port0_datGPIO, gpio_num_t port1_clkGPIO = GPIO_UNUSED, gpio_num_t port1_datGPIO = GPIO_UNUSED);
 
  static void begin(PS2Preset preset = PS2Preset::KeyboardPort0_MousePort1, KbdMode keyboardMode = KbdMode::CreateVirtualKeysQueue);
 
  static void end();
 
  static bool initialized() { return s_initDone; }
 
  static bool dataAvailable(int PS2Port);
 
  static int getData(int PS2Port, int timeOutMS);
 
  static void sendData(uint8_t data, int PS2Port);
 
  static void disableRX(int PS2Port);
 
  static void enableRX(int PS2Port);
 
  static Keyboard * keyboard()                { return s_keyboard; }
 
  static void setKeyboard(Keyboard * value)   { s_keyboard = value; }
 
  static Mouse * mouse()                      { return s_mouse; }
 
  static void setMouse(Mouse * value)         { s_mouse = value; }
 
  static PS2Controller * instance()           { return s_instance; }
 
  static bool parityError(int PS2Port)        { return s_parityError[PS2Port]; }
 
  static bool syncError(int PS2Port)          { return s_syncError[PS2Port]; }
 
  static bool CLKTimeOutError(int PS2Port)    { return s_CLKTimeOutError[PS2Port]; }
 
  static bool lock(int PS2Port, int timeOutMS);
 
  static void unlock(int PS2Port);
 
 
private:
 
 
  static void IRAM_ATTR ULPWakeISR(void * arg);
 
  static PS2Controller *    s_instance;
 
  // Keyboard and Mouse instances can be created by PS2Controller in one of the begin() calls, or can be
  // set using setKeyboard() and setMouse() calls.
  static Keyboard *         s_keyboard;
  static Mouse *            s_mouse;
 
  static bool               s_keyboardAllocated;
  static bool               s_mouseAllocated;
 
  static bool               s_portEnabled[2];
 
  static intr_handle_t      s_ULPWakeISRHandle;
 
  // true if last call to getData() had a parity, sync error (start or stop missing bits) or CLK timeout
  static bool               s_parityError[2];
  static bool               s_syncError[2];
  static bool               s_CLKTimeOutError[2];
 
  // one word queue (contains just the last received word)
  static QueueHandle_t      s_dataIn[2];
 
  static SemaphoreHandle_t  s_portLock[2];
 
  static bool               s_initDone;
 
};
 
 
struct PS2PortAutoDisableRX {
  PS2PortAutoDisableRX(int PS2Port) : port(PS2Port) {
    PS2Controller::disableRX(port);
  }
  ~PS2PortAutoDisableRX() {
    PS2Controller::enableRX(port);
  }
private:
  int port;
};
 
 
 
 
} // end of namespace