ra8_touch.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stddef.h>
#include <stdint.h>
 
#include "ra8_attributes.h"
#include "ra8_err.h"
#include "ra8_i2c_bus_ops.h"
 
/* ===========================================================================
 * Compile-time limits
 * ===========================================================================
 */

typedef enum : uint8_t {
  k_ra8_touch_max_points    = 5U,  
  k_ra8_touch_irq_pin_unset = 32U, 
} ra8_touch_limits_t;
 
/* ===========================================================================
 * Public types
 * ===========================================================================
 */

typedef struct {
  uint16_t x;        
  uint16_t y;        
  uint8_t  track_id; 
  uint8_t  pressure; 
} ra8_touch_point_t;

typedef struct {
  ra8_i2c_bus_ops_t bus;        
  uint8_t           target_7b;  
  uint8_t           irq_pin;    
  uint8_t           max_points; 
} ra8_touch_cfg_t;

typedef void (*ra8_touch_event_fn_t)(void* ctx);
 
/* ===========================================================================
 * Lifecycle
 * ===========================================================================
 */

[[nodiscard]] ra8_err_t ra8_touch_open(const ra8_touch_cfg_t* cfg);

[[nodiscard]] ra8_err_t ra8_touch_close(void);
 
/* ===========================================================================
 * Event handler attach / dispatch
 * ===========================================================================
 */

[[nodiscard]] ra8_err_t ra8_touch_attach_handler(ra8_touch_event_fn_t fn, void* ctx);

void ra8_touch_dispatch_irq(void);
 
/* ===========================================================================
 * Touch-point read
 * ===========================================================================
 */

[[nodiscard]] ra8_err_t
ra8_touch_read(ra8_touch_point_t* out_points, uint8_t max_count, uint8_t* got_count);

[[nodiscard]] ra8_err_t ra8_touch_calibrate(void);
 
#ifdef UNIT_TEST
RA8_TEST_HELPER [[nodiscard]] ra8_err_t ra8_touch_test_decode(const uint8_t*     raw,
                                                              uint8_t            n_points,
                                                              ra8_touch_point_t* out_points,
                                                              uint8_t            max_count,
                                                              uint8_t*           got_count);
#endif /* UNIT_TEST */
 
#ifdef __cplusplus
}
#endif