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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
|
/*
* tizen-radio.h
*
* Copyright (c) 2016 Samsung Electronics Co., Ltd. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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 __TIZEN_RADIO_HAL_H__
#define __TIZEN_RADIO_HAL_H__
#include <stdint.h>
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/**
* @file tizen-radio.h
* @brief This file contains the Tizen radio HAL API, related structures and enumerations.
* @since_tizen 3.0
*/
/**
* @addtogroup TIZEN_RADIO_HAL_MODULE
* @{
*/
/**
* @brief Enumeration for the radio error.
* @since_tizen 3.0
*/
typedef enum radio_error {
RADIO_ERROR_NONE,
RADIO_ERROR_INVALID_PARAMETER,
RADIO_ERROR_INVALID_OPERATION,
RADIO_ERROR_PERMISSION_DENIED,
RADIO_ERROR_NOT_SUPPORTED,
RADIO_ERROR_OUT_OF_MEMORY,
RADIO_ERROR_DEVICE_NOT_PREPARED,
RADIO_ERROR_DEVICE_NOT_OPENED,
RADIO_ERROR_DEVICE_NOT_FOUND,
RADIO_ERROR_NO_ANTENNA,
RADIO_ERROR_INTERNAL,
RADIO_ERROR_NOT_IMPLEMENTED,
RADIO_ERROR_UNKNOWN
} radio_error_t;
/**
* @brief Enumeration for the radio seek direction.
* @since_tizen 3.0
*/
typedef enum radio_seek_direction_type {
RADIO_SEEK_DIRECTION_UP, /**< Seek upward */
RADIO_SEEK_DIRECTION_DOWN /**< Seek downward */
} radio_seek_direction_type_t;
typedef struct radio_interface {
/* create & destroy */
radio_error_t (*init)(void **radio_hanle);
radio_error_t (*deinit)(void *radio_handle);
radio_error_t (*prepare)(void *radio_handle);
radio_error_t (*unprepare)(void *radio_handle);
radio_error_t (*open)(void *radio_handle);
radio_error_t (*close)(void *radio_handle);
radio_error_t (*start)(void *radio_handle);
radio_error_t (*stop)(void *radio_handle);
radio_error_t (*seek)(void *radio_handle, radio_seek_direction_type_t direction);
radio_error_t (*get_frequency)(void *radio_handle, uint32_t *frequency);
radio_error_t (*set_frequency)(void *radio_handle, uint32_t frequency);
radio_error_t (*mute)(void *radio_handle);
radio_error_t (*unmute)(void *radio_handle);
radio_error_t (*get_signal_strength)(void *radio_handle, int32_t *strength);
radio_error_t (*get_volume)(void *radio_handle, float *volume);
radio_error_t (*set_volume)(void *radio_handle, float volume);
radio_error_t (*set_media_volume)(void *radio_handle, uint32_t level);
} radio_interface_t;
/**
* @brief Initializes new handle of radio HAL.
* @since_tizen 3.0
* @param[out] radio_handle A newly returned the radio HAL handle
* @return @c 0 on success, otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
* @retval #RADIO_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #RADIO_ERROR_OUT_OF_MEMORY Out of memory
* @retval #RADIO_ERROR_INVALID_OPERATION Invalid operation
* @see radio_deinit()
*/
radio_error_t radio_init(void **radio_handle);
/**
* @brief Deinitializes handle of radio HAL.
* @since_tizen 3.0
* @param[in] radio_handle The radio HAL handle
* @return @c 0 on success, otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
* @retval #RADIO_ERROR_INVALID_PARAMETER Invalid parameter
* @see radio_init()
*/
radio_error_t radio_deinit(void *radio_handle);
/**
* @brief Prepare the device of radio.
* @since_tizen 3.0
* @param[in] radio_handle The radio HAL handle
* @return @c 0 on success, otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
* @retval #RADIO_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #RADIO_ERROR_INVALID_OPERATION Invalid operation
* @see radio_unprepare()
*/
radio_error_t radio_prepare(void *radio_handle);
/**
* @brief Unprepare the device of radio.
* @since_tizen 3.0
* @param[in] radio_handle The radio HAL handle
* @return @c 0 on success, otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
* @retval #RADIO_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #RADIO_ERROR_INVALID_OPERATION Invalid operation
* @see radio_prepare()
*/
radio_error_t radio_unprepare(void *radio_handle);
/**
* @brief Opens the device of radio.
* @since_tizen 3.0
* @param[in] radio_handle The radio HAL handle
* @return @c 0 on success, otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
* @retval #RADIO_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #RADIO_ERROR_DEVICE_NOT_FOUND Failed to find radio device
* @retval #RADIO_ERROR_INVALID_OPERATION Invalid operation
* @retval #RADIO_ERROR_PERMISSION_DENIED The access to the resources can not be granted.
* @retval #RADIO_ERROR_DEVICE_NOT_PREPARED Not prepared the radio device
* @see radio_close()
*/
radio_error_t radio_open(void *radio_handle);
/**
* @brief Closes the device of radio.
* @since_tizen 3.0
* @param[in] radio_handle The radio HAL handle
* @return @c 0 on success, otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
* @retval #RADIO_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #RADIO_ERROR_DEVICE_NOT_OPENED The radio device is not opened.
* @retval #RADIO_ERROR_INVALID_OPERATION Invalid operation
* @see radio_open()
*/
radio_error_t radio_close(void *radio_handle);
/**
* @brief Starts the device of radio.
* @since_tizen 3.0
* @param[in] radio_handle The radio HAL handle
* @return @c 0 on success, otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
* @retval #RADIO_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #RADIO_ERROR_DEVICE_NOT_OPENED The radio device is not opened.
* @see radio_stop()
*/
radio_error_t radio_start(void *radio_handle);
/**
* @brief Stops the device of radio.
* @since_tizen 3.0
* @param[in] radio_handle The radio HAL handle
* @return @c 0 on success, otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
* @retval #RADIO_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #RADIO_ERROR_DEVICE_NOT_OPENED The radio device is not opened.
* @see radio_start()
*/
radio_error_t radio_stop(void *radio_handle);
/**
* @brief Seeks (up or down) the effective frequency of the radio.
* @since_tizen 3.0
* @param[in] radio_handle The radio HAL handle
* @param[in] direction The seek direction type (up or down)
* @return @c 0 on success, otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
* @retval #RADIO_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #RADIO_ERROR_DEVICE_NOT_OPENED The radio device is not opened
* @retval #RADIO_ERROR_INVALID_OPERATION Invalid operation
*/
radio_error_t radio_seek(void *radio_handle, radio_seek_direction_type_t direction);
/**
* @brief Gets the radio frequency.
* @since_tizen 3.0
* @param[in] radio_handle The radio HAL handle
* @param[out] frequency The current frequency (khz)
* @return @c 0 on success, otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
* @retval #RADIO_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #RADIO_ERROR_INVALID_OPERATION Invalid operation
*/
radio_error_t radio_get_frequency(void *radio_handle, uint32_t *frequency);
/**
* @brief Sets the radio frequency.
* @since_tizen 3.0
* @param[in] radio_handle The radio HAL handle
* @param[in] frequency The frequency to set (khz)
* @return @c 0 on success, otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
* @retval #RADIO_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #RADIO_ERROR_INVALID_OPERATION Invalid operation
*/
radio_error_t radio_set_frequency(void *radio_handle, uint32_t frequency);
/**
* @brief Sets the radio's mute
* @since_tizen 3.0
* @param[in] radio_handle The radio HAL handle
* @return @c 0 on success, otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
* @retval #RADIO_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #RADIO_ERROR_INVALID_OPERATION Invalid operation
*/
radio_error_t radio_mute(void *radio_handle);
/**
* @brief Unsets the radio's mute
* @since_tizen 3.0
* @param[in] radio_handle The radio HAL handle
* @return @c 0 on success, otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
* @retval #RADIO_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #RADIO_ERROR_INVALID_OPERATION Invalid operation
*/
radio_error_t radio_unmute(void *radio_handle);
/**
* @brief Gets the current signal strength of the radio
* @since_tizen 3.0
* @param[in] radio_handle The radio HAL handle
* @param[out] strength The current signal strength (dBm)
* @return @c 0 on success, otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
* @retval #RADIO_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #RADIO_ERROR_INVALID_OPERATION Invalid operation
*/
radio_error_t radio_get_signal_strength(void *radio_handle, int32_t *strength);
/**
* @brief Gets the radio's current volume.
* @since_tizen 3.0
* @param[in] radio_handle The radio HAL handle
* @param[out] volume The current radio volume (0.0 ~ 1.0)
* @return @c 0 on success, otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
* @retval #RADIO_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #RADIO_ERROR_INVALID_OPERATION Invalid operation
*/
radio_error_t radio_get_volume(void *radio_handle, float *volume);
/**
* @brief Sets the current radio's volume.
* @since_tizen 3.0
* @param[in] radio_handle The radio HAL handle
* @param[in] volume The radio volume to set (0.0 ~ 1.0)
* @return @c 0 on success, otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
* @retval #RADIO_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #RADIO_ERROR_INVALID_OPERATION Invalid operation
*/
radio_error_t radio_set_volume(void *radio_handle, float volume);
/**
* @brief Sets the current media volume level(system media volume).
* @since_tizen 3.0
* @param[in] radio_handle The radio HAL handle
* @param[in] level The media volume level to set
* @return @c 0 on success, otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
* @retval #RADIO_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #RADIO_ERROR_INVALID_OPERATION Invalid operation
*/
radio_error_t radio_set_media_volume(void *radio_handle, uint32_t level);
/**
* @}
*/
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* __TIZEN_RADIO_HAL_H__ */
|
