apds990x.h 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
  1. /*
  2. * This file is part of the APDS990x sensor driver.
  3. * Chip is combined proximity and ambient light sensor.
  4. *
  5. * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
  6. *
  7. * Contact: Samu Onkalo <samu.p.onkalo@nokia.com>
  8. *
  9. * This program is free software; you can redistribute it and/or
  10. * modify it under the terms of the GNU General Public License
  11. * version 2 as published by the Free Software Foundation.
  12. *
  13. * This program is distributed in the hope that it will be useful, but
  14. * WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16. * General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU General Public License
  19. * along with this program; if not, write to the Free Software
  20. * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  21. * 02110-1301 USA
  22. *
  23. */
  24. #ifndef __APDS990X_H__
  25. #define __APDS990X_H__
  26. #define APDS_IRLED_CURR_12mA 0x3
  27. #define APDS_IRLED_CURR_25mA 0x2
  28. #define APDS_IRLED_CURR_50mA 0x1
  29. #define APDS_IRLED_CURR_100mA 0x0
  30. /**
  31. * struct apds990x_chip_factors - defines effect of the cover window
  32. * @ga: Total glass attenuation
  33. * @cf1: clear channel factor 1 for raw to lux conversion
  34. * @irf1: IR channel factor 1 for raw to lux conversion
  35. * @cf2: clear channel factor 2 for raw to lux conversion
  36. * @irf2: IR channel factor 2 for raw to lux conversion
  37. * @df: device factor for conversion formulas
  38. *
  39. * Structure for tuning ALS calculation to match with environment.
  40. * Values depend on the material above the sensor and the sensor
  41. * itself. If the GA is zero, driver will use uncovered sensor default values
  42. * format: decimal value * APDS_PARAM_SCALE except df which is plain integer.
  43. */
  44. #define APDS_PARAM_SCALE 4096
  45. struct apds990x_chip_factors {
  46. int ga;
  47. int cf1;
  48. int irf1;
  49. int cf2;
  50. int irf2;
  51. int df;
  52. };
  53. /**
  54. * struct apds990x_platform_data - platform data for apsd990x.c driver
  55. * @cf: chip factor data
  56. * @pddrive: IR-led driving current
  57. * @ppcount: number of IR pulses used for proximity estimation
  58. * @setup_resources: interrupt line setup call back function
  59. * @release_resources: interrupt line release call back function
  60. *
  61. * Proximity detection result depends heavily on correct ppcount, pdrive
  62. * and cover window.
  63. *
  64. */
  65. struct apds990x_platform_data {
  66. struct apds990x_chip_factors cf;
  67. u8 pdrive;
  68. u8 ppcount;
  69. int (*setup_resources)(void);
  70. int (*release_resources)(void);
  71. };
  72. #endif