tmf8829_types.h

Go to the documentation of this file.

/*
 * SPDX-License-Identifier: MIT
 *
 * Copyright (c) 2026 tmf8829_universal_driver contributors
 * Derived from ams-OSRAM TMF8829 reference drivers (MIT); adapted for portable multi-instance use.
 */

 
#ifndef TMF8829_TYPES_H
#define TMF8829_TYPES_H
 
#include <stddef.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif

struct tmf8829_driver;
struct tmf8829_ops;
 
typedef struct tmf8829_driver tmf8829_driver_t;
typedef struct tmf8829_ops tmf8829_ops_t;
 
/* ------------------------------------------------------------------ */
/* Bus selection                                                      */
/* ------------------------------------------------------------------ */

typedef enum tmf8829_bus {
  TMF8829_BUS_I2C = 0, 
  TMF8829_BUS_SPI = 1, 
} tmf8829_bus_t;
 
/* ------------------------------------------------------------------ */
/* Error / status codes                                               */
/* ------------------------------------------------------------------ */

typedef enum tmf8829_err {
  TMF8829_OK                = 0,   
  TMF8829_E_PARAM           = -1,  
  TMF8829_E_BUS             = -2,  
  TMF8829_E_TIMEOUT         = -3,  
  TMF8829_E_NO_RESULT       = -4,  
  TMF8829_E_BOOTLOADER      = -5,  
  TMF8829_E_STATE           = -6,  
  TMF8829_E_NOT_IMPLEMENTED = -99, 
} tmf8829_err_t;
 
/* ------------------------------------------------------------------ */
/* Logging                                                            */
/* ------------------------------------------------------------------ */

enum tmf8829_log_level {
  TMF8829_LOG_NONE           = 0x00, 
  TMF8829_LOG_ERROR          = 0x01, 
  TMF8829_LOG_RESULTS_HEADER = 0x02, 
  TMF8829_LOG_RESULTS        = 0x04, 
  TMF8829_LOG_CLK_CORRECTION = 0x08, 
  TMF8829_LOG_INFO           = 0x10, 
  TMF8829_LOG_VERBOSE        = 0x20, 
  TMF8829_LOG_BUS            = 0x80, 
  TMF8829_LOG_DEBUG          = 0xFF, 
};
 
/* ------------------------------------------------------------------ */
/* Compile-time configuration                                         */
/* ------------------------------------------------------------------ */

#ifndef TMF8829_CLK_CORRECTION_PAIRS
#define TMF8829_CLK_CORRECTION_PAIRS 4u
#endif

#ifndef TMF8829_MIN_BUFFER_SIZE
#define TMF8829_MIN_BUFFER_SIZE 256u
#endif
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* TMF8829_TYPES_H */