Diff: pah8011/pah_driver.h

Revision:

6:d196b612b14a

Parent:

0:242cf8f28bf2

--- a/pah8011/pah_driver.h	Fri Oct 27 08:21:32 2017 +0000
+++ b/pah8011/pah_driver.h	Wed Jan 23 08:01:57 2019 +0000
@@ -1,3 +1,11 @@
+/**
+ * @file sns_dd_pah_driver.h
+ *
+ * Copyright (c) 2016-2017 PixArt Imaging Inc.
+ * All Rights Reserved.
+ * Confidential and Proprietary - PixArt Imaging Inc.
+ **/
+
 /*==============================================================================
 * Edit History
 * 
@@ -7,29 +15,27 @@
 * 
 * when       who       what, where, why
 * ---------- ---       -----------------------------------------------------------
-* 2016-10-20 bh        - Move some public types to new file pah_driver_types.h for reuse.
-*                      - Add function: pah_fifo_data_num_per_ch().
-* 2016-09-08 bh        - Add functions: pah_init_with_flags().
+* 2016-10-14 bell      - Add functions: pah_init_with_flags().
 *                      - Add pah_ppg_led_on_e flag.
-* 2016-06-07 bh        - Add functions: pah_set_mode(), pah_run_device().
+* 2016-06-07 bell      - Add functions: pah_set_mode(), pah_run_device().
 *                      - Add enum: pah_device.
 *                      - Add comments.
-* 2016-04-29 bh        - Add PPG 200Hz modes.
+* 2016-04-29 bell      - Add PPG 200Hz modes.
 *                      - Add helper functions: pah_is_ppg_mode(), pah_is_ppg_20hz_mode(), pah_fifo_data_num_per_ch().
 *                      - Add pah_stop_mode
 *                      - Remove pah_suspend_mode.
 *                      - Fix setting pah_set_report_sample_num_per_ch() after enter_mode() causes bad behavior.
-* 2016-04-20 bh        Add pah_stop_mode. pah_none can be regarded as pah_stop_mode.
-* 2016-04-12 bh        Add license information and revision information.
-* 2016-04-07 bh        Initial revision.
+* 2016-04-20 bell      Add pah_stop_mode. pah_none can be regarded as pah_stop_mode.
+* 2016-04-12 bell      Add license information and revision information.
+* 2016-04-07 bell      Initial revision.
 ==============================================================================*/
 
-#ifndef __pah_driver_h__
-#define __pah_driver_h__
+#ifndef __sns_dd_pah_driver_h__
+#define __sns_dd_pah_driver_h__
 
-
+#include "pah_platform_types.h"
 #include "pah_driver_types.h"
-#include "pah_platform_types.h"
+#include "pah_ret.h"
 
 
 typedef struct {
@@ -42,12 +48,6 @@
 } pah_flags_s;
 
 
-/**
- * @brief Get default pah_flags_s.
- * 
- * @param[out] flags        Refer to struct pah_flags_s.
- */
-void        pah_flags_default(pah_flags_s *flags);
 
 /**
  * @brief Initialize the driver.
@@ -59,14 +59,14 @@
 bool        pah_init(void);
 
 /**
- * @brief Initialize the driver.
- * 
- * It should been called once before any other function calls.
- *
- * @param[in]  flags        Refer to struct pah_flags_s.
- *
- * @return True if successful.
- */
+* @brief Initialize the driver.
+*
+* It should been called once before any other function calls.
+*
+* @param[in]  flags        Refer to struct pah_flags_s.
+*
+* @return True if successful.
+*/
 bool        pah_init_with_flags(const pah_flags_s *flags);
 
 /**
@@ -280,6 +280,7 @@
  */
 uint32_t    pah_get_bytes_per_sample(void);
 
+
 /**
  * @brief Check if the driver is valid to the device.
  * 
@@ -303,3 +304,4 @@
 
 
 #endif  // header guard
+