hailey
/
qmk_firmware
mirror of https://github.com/hailey/qmk_firmware.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add support for multiple sensors to pmw3360 (#15996)

Browse Source
xap
uqs 3 years ago committed by GitHub
parent 9f63bce70b
commit 690dc4bdaf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 123 additions and 84 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 32
      docs/feature_pointing_device.md
  2. 155
      drivers/sensors/pmw3360.c
  3. 14
      drivers/sensors/pmw3360.h
  4. 4
      quantum/pointing_device_drivers.c

32
docs/feature_pointing_device.md
Unescape View File

@ -134,6 +134,7 @@ The Pimoroni Trackball module is a I2C based breakout board with an RGB enable t
### PMW 3360 Sensor ### PMW 3360 Sensor
This drivers supports multiple sensors _per_ controller, so 2 can be attached at the same side for split keyboards (or unsplit keyboards).
To use the PMW 3360 sensor, add this to your `rules.mk` To use the PMW 3360 sensor, add this to your `rules.mk`
```make ```make
@ -145,6 +146,7 @@ The PMW 3360 is an SPI driven optical sensor, that uses a built in IR LED for su
| Setting | Description | Default | | Setting | Description | Default |
|-----------------------------|--------------------------------------------------------------------------------------------|---------------| |-----------------------------|--------------------------------------------------------------------------------------------|---------------|
|`PMW3360_CS_PIN` | (Required) Sets the Cable Select pin connected to the sensor. | _not defined_ | |`PMW3360_CS_PIN` | (Required) Sets the Cable Select pin connected to the sensor. | _not defined_ |
|`PMW3360_CS_PINS` | (Alternative) Sets the Cable Select pins connected to multiple sensors. | _not defined_ |
|`PMW3360_CLOCK_SPEED` | (Optional) Sets the clock speed that the sensor runs at. | `2000000` | |`PMW3360_CLOCK_SPEED` | (Optional) Sets the clock speed that the sensor runs at. | `2000000` |
|`PMW3360_SPI_LSBFIRST` | (Optional) Sets the Least/Most Significant Byte First setting for SPI. | `false` | |`PMW3360_SPI_LSBFIRST` | (Optional) Sets the Least/Most Significant Byte First setting for SPI. | `false` |
|`PMW3360_SPI_MODE` | (Optional) Sets the SPI Mode for the sensor. | `3` | |`PMW3360_SPI_MODE` | (Optional) Sets the SPI Mode for the sensor. | `3` |
@ -155,6 +157,36 @@ The PMW 3360 is an SPI driven optical sensor, that uses a built in IR LED for su
The CPI range is 100-12000, in increments of 100. Defaults to 1600 CPI. The CPI range is 100-12000, in increments of 100. Defaults to 1600 CPI.
To use multiple sensors, instead of setting `PMW3360_CS_PIN` you need to set `PMW3360_CS_PINS` and also handle and merge the read from this sensor in user code.
Note that different (per sensor) values of CPI, speed liftoff, rotational angle or flipping of X/Y is not currently supported.
```c
// in config.h:
#define PMW3360_CS_PINS { B5, B6 }
// in keyboard.c:
#ifdef POINTING_DEVICE_ENABLE
void pointing_device_init_kb(void) {
pmw3360_init(1); // index 1 is the second device.
pointing_device_set_cpi(800); // applies to both sensors
pointing_device_init_user();
}
// Contains report from sensor #0 already, need to merge in from sensor #1
report_mouse_t pointing_device_task_kb(report_mouse_t mouse_report) {
report_pmw3360_t data = pmw3360_read_burst(1);
if (data.isOnSurface && data.isMotion) {
// From quantum/pointing_device_drivers.c
#define constrain_hid(amt) ((amt) < -127 ? -127 : ((amt) > 127 ? 127 : (amt)))
mouse_report.x = constrain_hid(mouse_report.x + data.dx);
mouse_report.y = constrain_hid(mouse_report.y + data.dy);
}
return pointing_device_task_user(mouse_report);
}
#endif
```
### PMW 3389 Sensor ### PMW 3389 Sensor
To use the PMW 3389 sensor, add this to your `rules.mk` To use the PMW 3389 sensor, add this to your `rules.mk`

155
drivers/sensors/pmw3360.c
Unescape View File

@ -1,6 +1,7 @@
/* Copyright 2020 Christopher Courtney, aka Drashna Jael're (@drashna) <drashna@live.com> /* Copyright 2020 Christopher Courtney, aka Drashna Jael're (@drashna) <drashna@live.com>
* Copyright 2019 Sunjun Kim * Copyright 2019 Sunjun Kim
* Copyright 2020 Ploopy Corporation * Copyright 2020 Ploopy Corporation
* Copyright 2022 Ulrich Spörlein
* *
* This program is free software: you can redistribute it and/or modify * This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by * it under the terms of the GNU General Public License as published by
@ -83,7 +84,11 @@
# define MAX_CPI 0x77 # define MAX_CPI 0x77
#endif #endif
bool _inBurst = false; static const pin_t pins[] = PMW3360_CS_PINS;
#define NUMBER_OF_SENSORS (sizeof(pins) / sizeof(pin_t))
// per-sensor driver state
static bool _inBurst[NUMBER_OF_SENSORS] = {0};
#ifdef CONSOLE_ENABLE #ifdef CONSOLE_ENABLE
void print_byte(uint8_t byte) { void print_byte(uint8_t byte) {
@ -92,18 +97,18 @@ void print_byte(uint8_t byte) {
#endif #endif
#define constrain(amt, low, high) ((amt) < (low) ? (low) : ((amt) > (high) ? (high) : (amt))) #define constrain(amt, low, high) ((amt) < (low) ? (low) : ((amt) > (high) ? (high) : (amt)))
bool pmw3360_spi_start(void) { bool pmw3360_spi_start(int8_t index) {
bool status = spi_start(PMW3360_CS_PIN, PMW3360_SPI_LSBFIRST, PMW3360_SPI_MODE, PMW3360_SPI_DIVISOR); bool status = spi_start(pins[index], PMW3360_SPI_LSBFIRST, PMW3360_SPI_MODE, PMW3360_SPI_DIVISOR);
// tNCS-SCLK, 120ns // tNCS-SCLK, 120ns
wait_us(1); wait_us(1);
return status; return status;
} }
spi_status_t pmw3360_write(uint8_t reg_addr, uint8_t data) { spi_status_t pmw3360_write(int8_t index, uint8_t reg_addr, uint8_t data) {
pmw3360_spi_start(); pmw3360_spi_start(index);
if (reg_addr != REG_Motion_Burst) { if (reg_addr != REG_Motion_Burst) {
_inBurst = false; _inBurst[index] = false;
} }
// send address of the register, with MSBit = 1 to indicate it's a write // send address of the register, with MSBit = 1 to indicate it's a write
@ -114,13 +119,13 @@ spi_status_t pmw3360_write(uint8_t reg_addr, uint8_t data) {
wait_us(35); wait_us(35);
spi_stop(); spi_stop();
// tSWW/tSWR (=180us) minus tSCLK-NCS. Could be shortened, but is looks like a safe lower bound // tSWW/tSWR (=180us) minus tSCLK-NCS. Could be shortened, but it looks like a safe lower bound
wait_us(145); wait_us(145);
return status; return status;
} }
uint8_t pmw3360_read(uint8_t reg_addr) { uint8_t pmw3360_read(int8_t index, uint8_t reg_addr) {
pmw3360_spi_start(); pmw3360_spi_start(index);
// send adress of the register, with MSBit = 0 to indicate it's a read // send adress of the register, with MSBit = 0 to indicate it's a read
spi_write(reg_addr & 0x7f); spi_write(reg_addr & 0x7f);
// tSRAD (=160us) // tSRAD (=160us)
@ -136,36 +141,62 @@ uint8_t pmw3360_read(uint8_t reg_addr) {
return data; return data;
} }
bool pmw3360_init(void) { bool pmw3360_check_signature(int8_t index) {
setPinOutput(PMW3360_CS_PIN); uint8_t pid = pmw3360_read(index, REG_Product_ID);
uint8_t iv_pid = pmw3360_read(index, REG_Inverse_Product_ID);
uint8_t SROM_ver = pmw3360_read(index, REG_SROM_ID);
return (pid == firmware_signature[0] && iv_pid == firmware_signature[1] && SROM_ver == firmware_signature[2]); // signature for SROM 0x04
}
spi_init(); void pmw3360_upload_firmware(int8_t index) {
_inBurst = false; // Datasheet claims we need to disable REST mode first, but during startup
// it's already disabled and we're not turning it on ...
// pmw3360_write(index, REG_Config2, 0x00); // disable REST mode
pmw3360_write(index, REG_SROM_Enable, 0x1d);
spi_stop(); wait_ms(10);
pmw3360_spi_start();
spi_stop(); pmw3360_write(index, REG_SROM_Enable, 0x18);
pmw3360_spi_start(index);
spi_write(REG_SROM_Load_Burst | 0x80);
wait_us(15);
pmw3360_write(REG_Shutdown, 0xb6); // Shutdown first for (uint16_t i = 0; i < FIRMWARE_LENGTH; i++) {
wait_ms(300); spi_write(pgm_read_byte(firmware_data + i));
#ifndef PMW3360_FIRMWARE_UPLOAD_FAST
wait_us(15);
#endif
}
wait_us(200);
pmw3360_spi_start(); pmw3360_read(index, REG_SROM_ID);
pmw3360_write(index, REG_Config2, 0x00);
}
bool pmw3360_init(int8_t index) {
if (index >= NUMBER_OF_SENSORS) {
return false;
}
spi_init();
// power up, need to first drive NCS high then low.
// the datasheet does not say for how long, 40us works well in practice.
pmw3360_spi_start(index);
wait_us(40); wait_us(40);
spi_stop(); spi_stop();
wait_us(40); wait_us(40);
pmw3360_write(index, REG_Power_Up_Reset, 0x5a);
// power up, need to first drive NCS high then low, see above.
pmw3360_write(REG_Power_Up_Reset, 0x5a);
wait_ms(50); wait_ms(50);
// read registers and discard // read registers and discard
pmw3360_read(REG_Motion); pmw3360_read(index, REG_Motion);
pmw3360_read(REG_Delta_X_L); pmw3360_read(index, REG_Delta_X_L);
pmw3360_read(REG_Delta_X_H); pmw3360_read(index, REG_Delta_X_H);
pmw3360_read(REG_Delta_Y_L); pmw3360_read(index, REG_Delta_Y_L);
pmw3360_read(REG_Delta_Y_H); pmw3360_read(index, REG_Delta_Y_H);
pmw3360_upload_firmware(); pmw3360_upload_firmware(index);
spi_stop(); spi_stop();
@ -174,13 +205,13 @@ bool pmw3360_init(void) {
wait_ms(1); wait_ms(1);
pmw3360_write(REG_Config2, 0x00); pmw3360_write(index, REG_Config2, 0x00);
pmw3360_write(REG_Angle_Tune, constrain(ROTATIONAL_TRANSFORM_ANGLE, -127, 127)); pmw3360_write(index, REG_Angle_Tune, constrain(ROTATIONAL_TRANSFORM_ANGLE, -127, 127));
pmw3360_write(REG_Lift_Config, PMW3360_LIFTOFF_DISTANCE); pmw3360_write(index, REG_Lift_Config, PMW3360_LIFTOFF_DISTANCE);
bool init_success = pmw3360_check_signature(); bool init_success = pmw3360_check_signature(index);
#ifdef CONSOLE_ENABLE #ifdef CONSOLE_ENABLE
if (init_success) { if (init_success) {
dprintf("pmw3360 signature verified"); dprintf("pmw3360 signature verified");
@ -189,66 +220,38 @@ bool pmw3360_init(void) {
} }
#endif #endif
writePinLow(PMW3360_CS_PIN);
return init_success; return init_success;
} }
void pmw3360_upload_firmware(void) { // Only support reading the value from sensor #0, no one is using this anyway.
// Datasheet claims we need to disable REST mode first, but during startup
// it's already disabled and we're not turning it on ...
// pmw3360_write(REG_Config2, 0x00); // disable REST mode
pmw3360_write(REG_SROM_Enable, 0x1d);
wait_ms(10);
pmw3360_write(REG_SROM_Enable, 0x18);
pmw3360_spi_start();
spi_write(REG_SROM_Load_Burst | 0x80);
wait_us(15);
for (uint16_t i = 0; i < FIRMWARE_LENGTH; i++) {
spi_write(pgm_read_byte(firmware_data + i));
#ifndef PMW3360_FIRMWARE_UPLOAD_FAST
wait_us(15);
#endif
}
wait_us(200);
pmw3360_read(REG_SROM_ID);
pmw3360_write(REG_Config2, 0x00);
}
bool pmw3360_check_signature(void) {
uint8_t pid = pmw3360_read(REG_Product_ID);
uint8_t iv_pid = pmw3360_read(REG_Inverse_Product_ID);
uint8_t SROM_ver = pmw3360_read(REG_SROM_ID);
return (pid == firmware_signature[0] && iv_pid == firmware_signature[1] && SROM_ver == firmware_signature[2]); // signature for SROM 0x04
}
uint16_t pmw3360_get_cpi(void) { uint16_t pmw3360_get_cpi(void) {
uint8_t cpival = pmw3360_read(REG_Config1); uint8_t cpival = pmw3360_read(0, REG_Config1);
return (uint16_t)((cpival + 1) & 0xFF) * CPI_STEP; return (uint16_t)((cpival + 1) & 0xFF) * CPI_STEP;
} }
// Write same CPI to all sensors.
void pmw3360_set_cpi(uint16_t cpi) { void pmw3360_set_cpi(uint16_t cpi) {
uint8_t cpival = constrain((cpi / CPI_STEP) - 1, 0, MAX_CPI); uint8_t cpival = constrain((cpi / CPI_STEP) - 1, 0, MAX_CPI);
pmw3360_write(REG_Config1, cpival); for (size_t i = 0; i < NUMBER_OF_SENSORS; i++) {
pmw3360_write(i, REG_Config1, cpival);
}
} }
report_pmw3360_t pmw3360_read_burst(void) { report_pmw3360_t pmw3360_read_burst(int8_t index) {
report_pmw3360_t report = {0}; report_pmw3360_t report = {0};
if (index >= NUMBER_OF_SENSORS) {
return report;
}
if (!_inBurst) { if (!_inBurst[index]) {
#ifdef CONSOLE_ENABLE #ifdef CONSOLE_ENABLE
dprintf("burst on"); dprintf("burst on for index %d", index);
#endif #endif
pmw3360_write(REG_Motion_Burst, 0x00); pmw3360_write(index, REG_Motion_Burst, 0x00);
_inBurst = true; _inBurst[index] = true;
} }
pmw3360_spi_start(); pmw3360_spi_start(index);
spi_write(REG_Motion_Burst); spi_write(REG_Motion_Burst);
wait_us(35); // waits for tSRAD_MOTBR wait_us(35); // waits for tSRAD_MOTBR
@ -261,7 +264,7 @@ report_pmw3360_t pmw3360_read_burst(void) {
report.mdy = spi_read(); report.mdy = spi_read();
if (report.motion & 0b111) { // panic recovery, sometimes burst mode works weird. if (report.motion & 0b111) { // panic recovery, sometimes burst mode works weird.
_inBurst = false; _inBurst[index] = false;
} }
spi_stop(); spi_stop();

14
drivers/sensors/pmw3360.h
Unescape View File

@ -52,8 +52,14 @@
# define ROTATIONAL_TRANSFORM_ANGLE 0x00 # define ROTATIONAL_TRANSFORM_ANGLE 0x00
#endif #endif
// Support single and plural spellings
#ifndef PMW3360_CS_PINS
# ifndef PMW3360_CS_PIN # ifndef PMW3360_CS_PIN
# error "No chip select pin defined -- missing PMW3360_CS_PIN" # error "No chip select pin defined -- missing PMW3360_CS_PIN or PMW3360_CS_PINS"
# else
# define PMW3360_CS_PINS \
{ PMW3360_CS_PIN }
# endif
#endif #endif
typedef struct { typedef struct {
@ -66,10 +72,8 @@ typedef struct {
int8_t mdy; int8_t mdy;
} report_pmw3360_t; } report_pmw3360_t;
bool pmw3360_init(void); bool pmw3360_init(int8_t index);
void pmw3360_upload_firmware(void);
bool pmw3360_check_signature(void);
uint16_t pmw3360_get_cpi(void); uint16_t pmw3360_get_cpi(void);
void pmw3360_set_cpi(uint16_t cpi); void pmw3360_set_cpi(uint16_t cpi);
/* Reads and clears the current delta values on the sensor */ /* Reads and clears the current delta values on the sensor */
report_pmw3360_t pmw3360_read_burst(void); report_pmw3360_t pmw3360_read_burst(int8_t index);

4
quantum/pointing_device_drivers.c
Unescape View File

@ -200,11 +200,11 @@ const pointing_device_driver_t pointing_device_driver = {
// clang-format on // clang-format on
#elif defined(POINTING_DEVICE_DRIVER_pmw3360) #elif defined(POINTING_DEVICE_DRIVER_pmw3360)
static void pmw3360_device_init(void) { static void pmw3360_device_init(void) {
pmw3360_init(); pmw3360_init(0);
} }
report_mouse_t pmw3360_get_report(report_mouse_t mouse_report) { report_mouse_t pmw3360_get_report(report_mouse_t mouse_report) {
report_pmw3360_t data = pmw3360_read_burst(); report_pmw3360_t data = pmw3360_read_burst(0);
static uint16_t MotionStart = 0; // Timer for accel, 0 is resting state static uint16_t MotionStart = 0; // Timer for accel, 0 is resting state
if (data.isOnSurface && data.isMotion) { if (data.isOnSurface && data.isMotion) {

Write Preview
Loading…
Cancel
Save