~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/linux/mfd/si476x-core.h

Version: ~ [ linux-4.18-rc1 ] ~ [ linux-4.17.2 ] ~ [ linux-4.16.16 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.50 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.109 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.138 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.19.8 ] ~ [ linux-3.18.113 ] ~ [ linux-3.17.8 ] ~ [ linux-3.16.57 ] ~ [ linux-3.15.10 ] ~ [ linux-3.14.79 ] ~ [ linux-3.13.11 ] ~ [ linux-3.12.74 ] ~ [ linux-3.11.10 ] ~ [ linux-3.10.108 ] ~ [ linux-3.9.11 ] ~ [ linux-3.8.13 ] ~ [ linux-3.7.10 ] ~ [ linux-3.6.11 ] ~ [ linux-3.5.7 ] ~ [ linux-3.4.113 ] ~ [ linux-3.3.8 ] ~ [ linux-3.2.102 ] ~ [ linux-3.1.10 ] ~ [ linux-3.0.101 ] ~ [ linux-2.6.39.4 ] ~ [ linux-2.6.38.8 ] ~ [ linux-2.6.37.6 ] ~ [ linux-2.6.36.4 ] ~ [ linux-2.6.35.14 ] ~ [ linux-2.6.34.15 ] ~ [ linux-2.6.33.20 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.27.62 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

  1 /*
  2  * include/media/si476x-core.h -- Common definitions for si476x core
  3  * device
  4  *
  5  * Copyright (C) 2012 Innovative Converged Devices(ICD)
  6  * Copyright (C) 2013 Andrey Smirnov
  7  *
  8  * Author: Andrey Smirnov <andrew.smirnov@gmail.com>
  9  *
 10  * This program is free software; you can redistribute it and/or modify
 11  * it under the terms of the GNU General Public License as published by
 12  * the Free Software Foundation; version 2 of the License.
 13  *
 14  * This program is distributed in the hope that it will be useful, but
 15  * WITHOUT ANY WARRANTY; without even the implied warranty of
 16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 17  * General Public License for more details.
 18  *
 19  */
 20 
 21 #ifndef SI476X_CORE_H
 22 #define SI476X_CORE_H
 23 
 24 #include <linux/kfifo.h>
 25 #include <linux/atomic.h>
 26 #include <linux/i2c.h>
 27 #include <linux/regmap.h>
 28 #include <linux/mutex.h>
 29 #include <linux/mfd/core.h>
 30 #include <linux/videodev2.h>
 31 #include <linux/regulator/consumer.h>
 32 
 33 #include <linux/mfd/si476x-platform.h>
 34 #include <linux/mfd/si476x-reports.h>
 35 
 36 /* Command Timeouts */
 37 #define SI476X_DEFAULT_TIMEOUT  100000
 38 #define SI476X_TIMEOUT_TUNE     700000
 39 #define SI476X_TIMEOUT_POWER_UP 330000
 40 #define SI476X_STATUS_POLL_US   0
 41 
 42 /* -------------------- si476x-i2c.c ----------------------- */
 43 
 44 enum si476x_freq_supported_chips {
 45         SI476X_CHIP_SI4761 = 1,
 46         SI476X_CHIP_SI4764,
 47         SI476X_CHIP_SI4768,
 48 };
 49 
 50 enum si476x_part_revisions {
 51         SI476X_REVISION_A10 = 0,
 52         SI476X_REVISION_A20 = 1,
 53         SI476X_REVISION_A30 = 2,
 54 };
 55 
 56 enum si476x_mfd_cells {
 57         SI476X_RADIO_CELL = 0,
 58         SI476X_CODEC_CELL,
 59         SI476X_MFD_CELLS,
 60 };
 61 
 62 /**
 63  * enum si476x_power_state - possible power state of the si476x
 64  * device.
 65  *
 66  * @SI476X_POWER_DOWN: In this state all regulators are turned off
 67  * and the reset line is pulled low. The device is completely
 68  * inactive.
 69  * @SI476X_POWER_UP_FULL: In this state all the power regualtors are
 70  * turned on, reset line pulled high, IRQ line is enabled(polling is
 71  * active for polling use scenario) and device is turned on with
 72  * POWER_UP command. The device is ready to be used.
 73  * @SI476X_POWER_INCONSISTENT: This state indicates that previous
 74  * power down was inconsistent, meaning some of the regulators were
 75  * not turned down and thus use of the device, without power-cycling
 76  * is impossible.
 77  */
 78 enum si476x_power_state {
 79         SI476X_POWER_DOWN               = 0,
 80         SI476X_POWER_UP_FULL            = 1,
 81         SI476X_POWER_INCONSISTENT       = 2,
 82 };
 83 
 84 /**
 85  * struct si476x_core - internal data structure representing the
 86  * underlying "core" device which all the MFD cell-devices use.
 87  *
 88  * @client: Actual I2C client used to transfer commands to the chip.
 89  * @chip_id: Last digit of the chip model(E.g. "1" for SI4761)
 90  * @cells: MFD cell devices created by this driver.
 91  * @cmd_lock: Mutex used to serialize all the requests to the core
 92  * device. This filed should not be used directly. Instead
 93  * si476x_core_lock()/si476x_core_unlock() should be used to get
 94  * exclusive access to the "core" device.
 95  * @users: Active users counter(Used by the radio cell)
 96  * @rds_read_queue: Wait queue used to wait for RDS data.
 97  * @rds_fifo: FIFO in which all the RDS data received from the chip is
 98  * placed.
 99  * @rds_fifo_drainer: Worker that drains on-chip RDS FIFO.
100  * @rds_drainer_is_working: Flag used for launching only one instance
101  * of the @rds_fifo_drainer.
102  * @rds_drainer_status_lock: Lock used to guard access to the
103  * @rds_drainer_is_working variable.
104  * @command: Wait queue for wainting on the command comapletion.
105  * @cts: Clear To Send flag set upon receiving first status with CTS
106  * set.
107  * @tuning: Wait queue used for wainting for tune/seek comand
108  * completion.
109  * @stc: Similar to @cts, but for the STC bit of the status value.
110  * @power_up_parameters: Parameters used as argument for POWER_UP
111  * command when the device is started.
112  * @state: Current power state of the device.
113  * @supplues: Structure containing handles to all power supplies used
114  * by the device (NULL ones are ignored).
115  * @gpio_reset: GPIO pin connectet to the RSTB pin of the chip.
116  * @pinmux: Chip's configurable pins configuration.
117  * @diversity_mode: Chips role when functioning in diversity mode.
118  * @status_monitor: Polling worker used in polling use case scenarion
119  * (when IRQ is not avalible).
120  * @revision: Chip's running firmware revision number(Used for correct
121  * command set support).
122  */
123 
124 struct si476x_core {
125         struct i2c_client *client;
126         struct regmap *regmap;
127         int chip_id;
128         struct mfd_cell cells[SI476X_MFD_CELLS];
129 
130         struct mutex cmd_lock; /* for serializing fm radio operations */
131         atomic_t users;
132 
133         wait_queue_head_t  rds_read_queue;
134         struct kfifo       rds_fifo;
135         struct work_struct rds_fifo_drainer;
136         bool               rds_drainer_is_working;
137         struct mutex       rds_drainer_status_lock;
138 
139         wait_queue_head_t command;
140         atomic_t          cts;
141 
142         wait_queue_head_t tuning;
143         atomic_t          stc;
144 
145         struct si476x_power_up_args power_up_parameters;
146 
147         enum si476x_power_state power_state;
148 
149         struct regulator_bulk_data supplies[4];
150 
151         int gpio_reset;
152 
153         struct si476x_pinmux pinmux;
154         enum si476x_phase_diversity_mode diversity_mode;
155 
156         atomic_t is_alive;
157 
158         struct delayed_work status_monitor;
159 #define SI476X_WORK_TO_CORE(w) container_of(to_delayed_work(w), \
160                                             struct si476x_core, \
161                                             status_monitor)
162 
163         int revision;
164 
165         int rds_fifo_depth;
166 };
167 
168 static inline struct si476x_core *i2c_mfd_cell_to_core(struct device *dev)
169 {
170         struct i2c_client *client = to_i2c_client(dev->parent);
171         return i2c_get_clientdata(client);
172 }
173 
174 
175 /**
176  * si476x_core_lock() - lock the core device to get an exclusive access
177  * to it.
178  */
179 static inline void si476x_core_lock(struct si476x_core *core)
180 {
181         mutex_lock(&core->cmd_lock);
182 }
183 
184 /**
185  * si476x_core_unlock() - unlock the core device to relinquish an
186  * exclusive access to it.
187  */
188 static inline void si476x_core_unlock(struct si476x_core *core)
189 {
190         mutex_unlock(&core->cmd_lock);
191 }
192 
193 /* *_TUNE_FREQ family of commands accept frequency in multiples of
194     10kHz */
195 static inline u16 hz_to_si476x(struct si476x_core *core, int freq)
196 {
197         u16 result;
198 
199         switch (core->power_up_parameters.func) {
200         default:
201         case SI476X_FUNC_FM_RECEIVER:
202                 result = freq / 10000;
203                 break;
204         case SI476X_FUNC_AM_RECEIVER:
205                 result = freq / 1000;
206                 break;
207         }
208 
209         return result;
210 }
211 
212 static inline int si476x_to_hz(struct si476x_core *core, u16 freq)
213 {
214         int result;
215 
216         switch (core->power_up_parameters.func) {
217         default:
218         case SI476X_FUNC_FM_RECEIVER:
219                 result = freq * 10000;
220                 break;
221         case SI476X_FUNC_AM_RECEIVER:
222                 result = freq * 1000;
223                 break;
224         }
225 
226         return result;
227 }
228 
229 /* Since the V4L2_TUNER_CAP_LOW flag is supplied, V4L2 subsystem
230  * mesures frequency in 62.5 Hz units */
231 
232 static inline int hz_to_v4l2(int freq)
233 {
234         return (freq * 10) / 625;
235 }
236 
237 static inline int v4l2_to_hz(int freq)
238 {
239         return (freq * 625) / 10;
240 }
241 
242 static inline u16 v4l2_to_si476x(struct si476x_core *core, int freq)
243 {
244         return hz_to_si476x(core, v4l2_to_hz(freq));
245 }
246 
247 static inline int si476x_to_v4l2(struct si476x_core *core, u16 freq)
248 {
249         return hz_to_v4l2(si476x_to_hz(core, freq));
250 }
251 
252 
253 
254 /**
255  * struct si476x_func_info - structure containing result of the
256  * FUNC_INFO command.
257  *
258  * @firmware.major: Firmware major number.
259  * @firmware.minor[...]: Firmware minor numbers.
260  * @patch_id:
261  * @func: Mode tuner is working in.
262  */
263 struct si476x_func_info {
264         struct {
265                 u8 major, minor[2];
266         } firmware;
267         u16 patch_id;
268         enum si476x_func func;
269 };
270 
271 /**
272  * struct si476x_power_down_args - structure used to pass parameters
273  * to POWER_DOWN command
274  *
275  * @xosc: true - Power down, but leav oscillator running.
276  *        false - Full power down.
277  */
278 struct si476x_power_down_args {
279         bool xosc;
280 };
281 
282 /**
283  * enum si476x_tunemode - enum representing possible tune modes for
284  * the chip.
285  * @SI476X_TM_VALIDATED_NORMAL_TUNE: Unconditionally stay on the new
286  * channel after tune, tune status is valid.
287  * @SI476X_TM_INVALIDATED_FAST_TUNE: Unconditionally stay in the new
288  * channel after tune, tune status invalid.
289  * @SI476X_TM_VALIDATED_AF_TUNE: Jump back to previous channel if
290  * metric thresholds are not met.
291  * @SI476X_TM_VALIDATED_AF_CHECK: Unconditionally jump back to the
292  * previous channel.
293  */
294 enum si476x_tunemode {
295         SI476X_TM_VALIDATED_NORMAL_TUNE = 0,
296         SI476X_TM_INVALIDATED_FAST_TUNE = 1,
297         SI476X_TM_VALIDATED_AF_TUNE     = 2,
298         SI476X_TM_VALIDATED_AF_CHECK    = 3,
299 };
300 
301 /**
302  * enum si476x_smoothmetrics - enum containing the possible setting fo
303  * audio transitioning of the chip
304  * @SI476X_SM_INITIALIZE_AUDIO: Initialize audio state to match this
305  * new channel
306  * @SI476X_SM_TRANSITION_AUDIO: Transition audio state from previous
307  * channel values to the new values
308  */
309 enum si476x_smoothmetrics {
310         SI476X_SM_INITIALIZE_AUDIO = 0,
311         SI476X_SM_TRANSITION_AUDIO = 1,
312 };
313 
314 /**
315  * struct si476x_rds_status_report - the structure representing the
316  * response to 'FM_RD_STATUS' command
317  * @rdstpptyint: Traffic program flag(TP) and/or program type(PTY)
318  * code has changed.
319  * @rdspiint: Program identification(PI) code has changed.
320  * @rdssyncint: RDS synchronization has changed.
321  * @rdsfifoint: RDS was received and the RDS FIFO has at least
322  * 'FM_RDS_INTERRUPT_FIFO_COUNT' elements in it.
323  * @tpptyvalid: TP flag and PTY code are valid falg.
324  * @pivalid: PI code is valid flag.
325  * @rdssync: RDS is currently synchronized.
326  * @rdsfifolost: On or more RDS groups have been lost/discarded flag.
327  * @tp: Current channel's TP flag.
328  * @pty: Current channel's PTY code.
329  * @pi: Current channel's PI code.
330  * @rdsfifoused: Number of blocks remaining in the RDS FIFO (0 if
331  * empty).
332  */
333 struct si476x_rds_status_report {
334         bool rdstpptyint, rdspiint, rdssyncint, rdsfifoint;
335         bool tpptyvalid, pivalid, rdssync, rdsfifolost;
336         bool tp;
337 
338         u8 pty;
339         u16 pi;
340 
341         u8 rdsfifoused;
342         u8 ble[4];
343 
344         struct v4l2_rds_data rds[4];
345 };
346 
347 struct si476x_rsq_status_args {
348         bool primary;
349         bool rsqack;
350         bool attune;
351         bool cancel;
352         bool stcack;
353 };
354 
355 enum si476x_injside {
356         SI476X_INJSIDE_AUTO     = 0,
357         SI476X_INJSIDE_LOW      = 1,
358         SI476X_INJSIDE_HIGH     = 2,
359 };
360 
361 struct si476x_tune_freq_args {
362         bool zifsr;
363         bool hd;
364         enum si476x_injside injside;
365         int freq;
366         enum si476x_tunemode tunemode;
367         enum si476x_smoothmetrics smoothmetrics;
368         int antcap;
369 };
370 
371 int  si476x_core_stop(struct si476x_core *, bool);
372 int  si476x_core_start(struct si476x_core *, bool);
373 int  si476x_core_set_power_state(struct si476x_core *, enum si476x_power_state);
374 bool si476x_core_has_am(struct si476x_core *);
375 bool si476x_core_has_diversity(struct si476x_core *);
376 bool si476x_core_is_a_secondary_tuner(struct si476x_core *);
377 bool si476x_core_is_a_primary_tuner(struct si476x_core *);
378 bool si476x_core_is_in_am_receiver_mode(struct si476x_core *core);
379 bool si476x_core_is_powered_up(struct si476x_core *core);
380 
381 enum si476x_i2c_type {
382         SI476X_I2C_SEND,
383         SI476X_I2C_RECV
384 };
385 
386 int si476x_core_i2c_xfer(struct si476x_core *,
387                          enum si476x_i2c_type,
388                          char *, int);
389 
390 
391 /* -------------------- si476x-cmd.c ----------------------- */
392 
393 int si476x_core_cmd_func_info(struct si476x_core *, struct si476x_func_info *);
394 int si476x_core_cmd_set_property(struct si476x_core *, u16, u16);
395 int si476x_core_cmd_get_property(struct si476x_core *, u16);
396 int si476x_core_cmd_dig_audio_pin_cfg(struct si476x_core *,
397                                       enum si476x_dclk_config,
398                                       enum si476x_dfs_config,
399                                       enum si476x_dout_config,
400                                       enum si476x_xout_config);
401 int si476x_core_cmd_zif_pin_cfg(struct si476x_core *,
402                                 enum si476x_iqclk_config,
403                                 enum si476x_iqfs_config,
404                                 enum si476x_iout_config,
405                                 enum si476x_qout_config);
406 int si476x_core_cmd_ic_link_gpo_ctl_pin_cfg(struct si476x_core *,
407                                             enum si476x_icin_config,
408                                             enum si476x_icip_config,
409                                             enum si476x_icon_config,
410                                             enum si476x_icop_config);
411 int si476x_core_cmd_ana_audio_pin_cfg(struct si476x_core *,
412                                       enum si476x_lrout_config);
413 int si476x_core_cmd_intb_pin_cfg(struct si476x_core *, enum si476x_intb_config,
414                                  enum si476x_a1_config);
415 int si476x_core_cmd_fm_seek_start(struct si476x_core *, bool, bool);
416 int si476x_core_cmd_am_seek_start(struct si476x_core *, bool, bool);
417 int si476x_core_cmd_fm_rds_status(struct si476x_core *, bool, bool, bool,
418                                   struct si476x_rds_status_report *);
419 int si476x_core_cmd_fm_rds_blockcount(struct si476x_core *, bool,
420                                       struct si476x_rds_blockcount_report *);
421 int si476x_core_cmd_fm_tune_freq(struct si476x_core *,
422                                  struct si476x_tune_freq_args *);
423 int si476x_core_cmd_am_tune_freq(struct si476x_core *,
424                                  struct si476x_tune_freq_args *);
425 int si476x_core_cmd_am_rsq_status(struct si476x_core *,
426                                   struct si476x_rsq_status_args *,
427                                   struct si476x_rsq_status_report *);
428 int si476x_core_cmd_fm_rsq_status(struct si476x_core *,
429                                   struct si476x_rsq_status_args *,
430                                   struct si476x_rsq_status_report *);
431 int si476x_core_cmd_power_up(struct si476x_core *,
432                              struct si476x_power_up_args *);
433 int si476x_core_cmd_power_down(struct si476x_core *,
434                                struct si476x_power_down_args *);
435 int si476x_core_cmd_fm_phase_div_status(struct si476x_core *);
436 int si476x_core_cmd_fm_phase_diversity(struct si476x_core *,
437                                        enum si476x_phase_diversity_mode);
438 
439 int si476x_core_cmd_fm_acf_status(struct si476x_core *,
440                                   struct si476x_acf_status_report *);
441 int si476x_core_cmd_am_acf_status(struct si476x_core *,
442                                   struct si476x_acf_status_report *);
443 int si476x_core_cmd_agc_status(struct si476x_core *,
444                                struct si476x_agc_status_report *);
445 
446 enum si476x_power_grid_type {
447         SI476X_POWER_GRID_50HZ = 0,
448         SI476X_POWER_GRID_60HZ,
449 };
450 
451 /* Properties  */
452 
453 enum si476x_interrupt_flags {
454         SI476X_STCIEN = (1 << 0),
455         SI476X_ACFIEN = (1 << 1),
456         SI476X_RDSIEN = (1 << 2),
457         SI476X_RSQIEN = (1 << 3),
458 
459         SI476X_ERRIEN = (1 << 6),
460         SI476X_CTSIEN = (1 << 7),
461 
462         SI476X_STCREP = (1 << 8),
463         SI476X_ACFREP = (1 << 9),
464         SI476X_RDSREP = (1 << 10),
465         SI476X_RSQREP = (1 << 11),
466 };
467 
468 enum si476x_rdsint_sources {
469         SI476X_RDSTPPTY = (1 << 4),
470         SI476X_RDSPI    = (1 << 3),
471         SI476X_RDSSYNC  = (1 << 1),
472         SI476X_RDSRECV  = (1 << 0),
473 };
474 
475 enum si476x_status_response_bits {
476         SI476X_CTS        = (1 << 7),
477         SI476X_ERR        = (1 << 6),
478         /* Status response for WB receiver */
479         SI476X_WB_ASQ_INT = (1 << 4),
480         SI476X_RSQ_INT    = (1 << 3),
481         /* Status response for FM receiver */
482         SI476X_FM_RDS_INT = (1 << 2),
483         SI476X_ACF_INT    = (1 << 1),
484         SI476X_STC_INT    = (1 << 0),
485 };
486 
487 /* -------------------- si476x-prop.c ----------------------- */
488 
489 enum si476x_common_receiver_properties {
490         SI476X_PROP_INT_CTL_ENABLE                      = 0x0000,
491         SI476X_PROP_DIGITAL_IO_INPUT_SAMPLE_RATE        = 0x0200,
492         SI476X_PROP_DIGITAL_IO_INPUT_FORMAT             = 0x0201,
493         SI476X_PROP_DIGITAL_IO_OUTPUT_SAMPLE_RATE       = 0x0202,
494         SI476X_PROP_DIGITAL_IO_OUTPUT_FORMAT            = 0x0203,
495 
496         SI476X_PROP_SEEK_BAND_BOTTOM                    = 0x1100,
497         SI476X_PROP_SEEK_BAND_TOP                       = 0x1101,
498         SI476X_PROP_SEEK_FREQUENCY_SPACING              = 0x1102,
499 
500         SI476X_PROP_VALID_MAX_TUNE_ERROR                = 0x2000,
501         SI476X_PROP_VALID_SNR_THRESHOLD                 = 0x2003,
502         SI476X_PROP_VALID_RSSI_THRESHOLD                = 0x2004,
503 };
504 
505 enum si476x_am_receiver_properties {
506         SI476X_PROP_AUDIO_PWR_LINE_FILTER               = 0x0303,
507 };
508 
509 enum si476x_fm_receiver_properties {
510         SI476X_PROP_AUDIO_DEEMPHASIS                    = 0x0302,
511 
512         SI476X_PROP_FM_RDS_INTERRUPT_SOURCE             = 0x4000,
513         SI476X_PROP_FM_RDS_INTERRUPT_FIFO_COUNT         = 0x4001,
514         SI476X_PROP_FM_RDS_CONFIG                       = 0x4002,
515 };
516 
517 enum si476x_prop_audio_pwr_line_filter_bits {
518         SI476X_PROP_PWR_HARMONICS_MASK  = 0x001f,
519         SI476X_PROP_PWR_GRID_MASK       = 0x0100,
520         SI476X_PROP_PWR_ENABLE_MASK     = 0x0200,
521         SI476X_PROP_PWR_GRID_50HZ       = 0x0000,
522         SI476X_PROP_PWR_GRID_60HZ       = 0x0100,
523 };
524 
525 enum si476x_prop_fm_rds_config_bits {
526         SI476X_PROP_RDSEN_MASK  = 0x1,
527         SI476X_PROP_RDSEN       = 0x1,
528 };
529 
530 
531 struct regmap *devm_regmap_init_si476x(struct si476x_core *);
532 
533 #endif  /* SI476X_CORE_H */
534 

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp