qmk-firmware/drivers/sensors/pmw3389.h
Alabastard-64 2842ab4052
Add PMW3389 optical sensor Support (Updated) (#15740)
Co-authored-by: Drashna Jaelre <drashna@live.com>
2022-01-11 14:33:13 -08:00

77 lines
2.2 KiB
C

/* Copyright 2021 Alabastard (@Alabastard-64)
* Copyright 2020 Christopher Courtney, aka Drashna Jael're (@drashna) <drashna@live.com>
* Copyright 2019 Sunjun Kim
* Copyright 2020 Ploopy Corporation
*
* 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
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
*/
#pragma once
#include <stdint.h>
#ifndef PMW3389_CPI
# define PMW3389_CPI 2000
#endif
#ifndef PMW3389_CLOCK_SPEED
# define PMW3389_CLOCK_SPEED 2000000
#endif
#ifndef PMW3389_SPI_LSBFIRST
# define PMW3389_SPI_LSBFIRST false
#endif
#ifndef PMW3389_SPI_MODE
# define PMW3389_SPI_MODE 3
#endif
#ifndef PMW3389_SPI_DIVISOR
# ifdef __AVR__
# define PMW3389_SPI_DIVISOR (F_CPU / PMW3389_CLOCK_SPEED)
# else
# define PMW3389_SPI_DIVISOR 64
# endif
#endif
#ifndef PMW3389_LIFTOFF_DISTANCE
# define PMW3389_LIFTOFF_DISTANCE 0x02
#endif
#ifndef ROTATIONAL_TRANSFORM_ANGLE
# define ROTATIONAL_TRANSFORM_ANGLE 0x00
#endif
#ifndef PMW3389_CS_PIN
# error "No chip select pin defined -- missing PMW3389_CS_PIN"
#endif
typedef struct {
int8_t motion;
bool isMotion; // True if a motion is detected.
bool isOnSurface; // True when a chip is on a surface
int16_t dx; // displacement on x directions. Unit: Count. (CPI * Count = Inch value)
int8_t mdx;
int16_t dy; // displacement on y directions.
int8_t mdy;
} report_pmw3389_t;
bool pmw3389_init(void);
void pmw3389_upload_firmware(void);
bool pmw3389_check_signature(void);
uint16_t pmw3389_get_cpi(void);
void pmw3389_set_cpi(uint16_t cpi);
/* Reads and clears the current delta values on the sensor */
report_pmw3389_t pmw3389_read_burst(void);