summaryrefslogtreecommitdiff
path: root/inc/resource/resource_sound_detection_sensor.h
blob: 3bcdf2deddb79d5f03a1f7f1435bd0b00393e14b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
/*
 * Copyright (c) 2017 Samsung Electronics Co., Ltd.
 *
 * Contact: Jin Yoon <jinny.yoon@samsung.com>
 *          Geunsun Lee <gs86.lee@samsung.com>
 *          Eunyoung Lee <ey928.lee@samsung.com>
 *          Junkyu Han <junkyu.han@samsung.com>
 *
 * Licensed under the Flora License, Version 1.1 (the License);
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://floralicense.org/license/
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an AS IS BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef __POSITION_FINDER_RESOURCE_SOUND_DETECTION_SENSOR_H__
#define __POSITION_FINDER_RESOURCE_SOUND_DETECTION_SENSOR_H__

/**
 * @brief Reads the value of gpio connected sound detection sensor(NS-SDSM).
 * @param[in] pin_num The number of the gpio pin connected to the sound detection sensor
 * @param[out] out_value The vaule of the gpio (zero or non-zero)
 * @return 0 on success, otherwise a negative error value
 *
 * @see If the gpio pin is not open, creates gpio handle before reading the value of gpio.
 */
extern int resource_read_sound_detection_sensor(int pin_num, int *out_value);

#endif /* __POSITION_FINDER_RESOURCE_SOUND_DETECTION_SENSOR_H__ */