/* SPDX-License-Identifier: GPL-2.0-only */ /* * include/media/si476x-core.h -- Common definitions for si476x core * device * * Copyright (C) 2012 Innovative Converged Devices(ICD) * Copyright (C) 2013 Andrey Smirnov * * Author: Andrey Smirnov <[email protected]> */ #ifndef SI476X_CORE_H #define SI476X_CORE_H #include <linux/kfifo.h> #include <linux/atomic.h> #include <linux/i2c.h> #include <linux/regmap.h> #include <linux/mutex.h> #include <linux/mfd/core.h> #include <linux/videodev2.h> #include <linux/regulator/consumer.h> #include <linux/mfd/si476x-platform.h> #include <linux/mfd/si476x-reports.h> /* Command Timeouts */ #define SI476X_DEFAULT_TIMEOUT … #define SI476X_TIMEOUT_TUNE … #define SI476X_TIMEOUT_POWER_UP … #define SI476X_STATUS_POLL_US … /* -------------------- si476x-i2c.c ----------------------- */ enum si476x_freq_supported_chips { … }; enum si476x_part_revisions { … }; enum si476x_mfd_cells { … }; /** * enum si476x_power_state - possible power state of the si476x * device. * * @SI476X_POWER_DOWN: In this state all regulators are turned off * and the reset line is pulled low. The device is completely * inactive. * @SI476X_POWER_UP_FULL: In this state all the power regulators are * turned on, reset line pulled high, IRQ line is enabled(polling is * active for polling use scenario) and device is turned on with * POWER_UP command. The device is ready to be used. * @SI476X_POWER_INCONSISTENT: This state indicates that previous * power down was inconsistent, meaning some of the regulators were * not turned down and thus use of the device, without power-cycling * is impossible. */ enum si476x_power_state { … }; /** * struct si476x_core - internal data structure representing the * underlying "core" device which all the MFD cell-devices use. * * @client: Actual I2C client used to transfer commands to the chip. * @chip_id: Last digit of the chip model(E.g. "1" for SI4761) * @cells: MFD cell devices created by this driver. * @cmd_lock: Mutex used to serialize all the requests to the core * device. This filed should not be used directly. Instead * si476x_core_lock()/si476x_core_unlock() should be used to get * exclusive access to the "core" device. * @users: Active users counter(Used by the radio cell) * @rds_read_queue: Wait queue used to wait for RDS data. * @rds_fifo: FIFO in which all the RDS data received from the chip is * placed. * @rds_fifo_drainer: Worker that drains on-chip RDS FIFO. * @rds_drainer_is_working: Flag used for launching only one instance * of the @rds_fifo_drainer. * @rds_drainer_status_lock: Lock used to guard access to the * @rds_drainer_is_working variable. * @command: Wait queue for wainting on the command comapletion. * @cts: Clear To Send flag set upon receiving first status with CTS * set. * @tuning: Wait queue used for wainting for tune/seek comand * completion. * @stc: Similar to @cts, but for the STC bit of the status value. * @power_up_parameters: Parameters used as argument for POWER_UP * command when the device is started. * @state: Current power state of the device. * @supplues: Structure containing handles to all power supplies used * by the device (NULL ones are ignored). * @gpio_reset: GPIO pin connectet to the RSTB pin of the chip. * @pinmux: Chip's configurable pins configuration. * @diversity_mode: Chips role when functioning in diversity mode. * @status_monitor: Polling worker used in polling use case scenarion * (when IRQ is not avalible). * @revision: Chip's running firmware revision number(Used for correct * command set support). */ struct si476x_core { … }; static inline struct si476x_core *i2c_mfd_cell_to_core(struct device *dev) { … } /** * si476x_core_lock() - lock the core device to get an exclusive access * to it. */ static inline void si476x_core_lock(struct si476x_core *core) { … } /** * si476x_core_unlock() - unlock the core device to relinquish an * exclusive access to it. */ static inline void si476x_core_unlock(struct si476x_core *core) { … } /* *_TUNE_FREQ family of commands accept frequency in multiples of 10kHz */ static inline u16 hz_to_si476x(struct si476x_core *core, int freq) { … } static inline int si476x_to_hz(struct si476x_core *core, u16 freq) { … } /* Since the V4L2_TUNER_CAP_LOW flag is supplied, V4L2 subsystem * mesures frequency in 62.5 Hz units */ static inline int hz_to_v4l2(int freq) { … } static inline int v4l2_to_hz(int freq) { … } static inline u16 v4l2_to_si476x(struct si476x_core *core, int freq) { … } static inline int si476x_to_v4l2(struct si476x_core *core, u16 freq) { … } /** * struct si476x_func_info - structure containing result of the * FUNC_INFO command. * * @firmware.major: Firmware major number. * @firmware.minor[...]: Firmware minor numbers. * @patch_id: * @func: Mode tuner is working in. */ struct si476x_func_info { … }; /** * struct si476x_power_down_args - structure used to pass parameters * to POWER_DOWN command * * @xosc: true - Power down, but leav oscillator running. * false - Full power down. */ struct si476x_power_down_args { … }; /** * enum si476x_tunemode - enum representing possible tune modes for * the chip. * @SI476X_TM_VALIDATED_NORMAL_TUNE: Unconditionally stay on the new * channel after tune, tune status is valid. * @SI476X_TM_INVALIDATED_FAST_TUNE: Unconditionally stay in the new * channel after tune, tune status invalid. * @SI476X_TM_VALIDATED_AF_TUNE: Jump back to previous channel if * metric thresholds are not met. * @SI476X_TM_VALIDATED_AF_CHECK: Unconditionally jump back to the * previous channel. */ enum si476x_tunemode { … }; /** * enum si476x_smoothmetrics - enum containing the possible setting fo * audio transitioning of the chip * @SI476X_SM_INITIALIZE_AUDIO: Initialize audio state to match this * new channel * @SI476X_SM_TRANSITION_AUDIO: Transition audio state from previous * channel values to the new values */ enum si476x_smoothmetrics { … }; /** * struct si476x_rds_status_report - the structure representing the * response to 'FM_RD_STATUS' command * @rdstpptyint: Traffic program flag(TP) and/or program type(PTY) * code has changed. * @rdspiint: Program identification(PI) code has changed. * @rdssyncint: RDS synchronization has changed. * @rdsfifoint: RDS was received and the RDS FIFO has at least * 'FM_RDS_INTERRUPT_FIFO_COUNT' elements in it. * @tpptyvalid: TP flag and PTY code are valid falg. * @pivalid: PI code is valid flag. * @rdssync: RDS is currently synchronized. * @rdsfifolost: On or more RDS groups have been lost/discarded flag. * @tp: Current channel's TP flag. * @pty: Current channel's PTY code. * @pi: Current channel's PI code. * @rdsfifoused: Number of blocks remaining in the RDS FIFO (0 if * empty). */ struct si476x_rds_status_report { … }; struct si476x_rsq_status_args { … }; enum si476x_injside { … }; struct si476x_tune_freq_args { … }; int si476x_core_stop(struct si476x_core *, bool); int si476x_core_start(struct si476x_core *, bool); int si476x_core_set_power_state(struct si476x_core *, enum si476x_power_state); bool si476x_core_has_am(struct si476x_core *); bool si476x_core_has_diversity(struct si476x_core *); bool si476x_core_is_a_secondary_tuner(struct si476x_core *); bool si476x_core_is_a_primary_tuner(struct si476x_core *); bool si476x_core_is_in_am_receiver_mode(struct si476x_core *core); bool si476x_core_is_powered_up(struct si476x_core *core); enum si476x_i2c_type { … }; int si476x_core_i2c_xfer(struct si476x_core *, enum si476x_i2c_type, char *, int); /* -------------------- si476x-cmd.c ----------------------- */ int si476x_core_cmd_func_info(struct si476x_core *, struct si476x_func_info *); int si476x_core_cmd_set_property(struct si476x_core *, u16, u16); int si476x_core_cmd_get_property(struct si476x_core *, u16); int si476x_core_cmd_dig_audio_pin_cfg(struct si476x_core *, enum si476x_dclk_config, enum si476x_dfs_config, enum si476x_dout_config, enum si476x_xout_config); int si476x_core_cmd_zif_pin_cfg(struct si476x_core *, enum si476x_iqclk_config, enum si476x_iqfs_config, enum si476x_iout_config, enum si476x_qout_config); int si476x_core_cmd_ic_link_gpo_ctl_pin_cfg(struct si476x_core *, enum si476x_icin_config, enum si476x_icip_config, enum si476x_icon_config, enum si476x_icop_config); int si476x_core_cmd_ana_audio_pin_cfg(struct si476x_core *, enum si476x_lrout_config); int si476x_core_cmd_intb_pin_cfg(struct si476x_core *, enum si476x_intb_config, enum si476x_a1_config); int si476x_core_cmd_fm_seek_start(struct si476x_core *, bool, bool); int si476x_core_cmd_am_seek_start(struct si476x_core *, bool, bool); int si476x_core_cmd_fm_rds_status(struct si476x_core *, bool, bool, bool, struct si476x_rds_status_report *); int si476x_core_cmd_fm_rds_blockcount(struct si476x_core *, bool, struct si476x_rds_blockcount_report *); int si476x_core_cmd_fm_tune_freq(struct si476x_core *, struct si476x_tune_freq_args *); int si476x_core_cmd_am_tune_freq(struct si476x_core *, struct si476x_tune_freq_args *); int si476x_core_cmd_am_rsq_status(struct si476x_core *, struct si476x_rsq_status_args *, struct si476x_rsq_status_report *); int si476x_core_cmd_fm_rsq_status(struct si476x_core *, struct si476x_rsq_status_args *, struct si476x_rsq_status_report *); int si476x_core_cmd_power_up(struct si476x_core *, struct si476x_power_up_args *); int si476x_core_cmd_power_down(struct si476x_core *, struct si476x_power_down_args *); int si476x_core_cmd_fm_phase_div_status(struct si476x_core *); int si476x_core_cmd_fm_phase_diversity(struct si476x_core *, enum si476x_phase_diversity_mode); int si476x_core_cmd_fm_acf_status(struct si476x_core *, struct si476x_acf_status_report *); int si476x_core_cmd_am_acf_status(struct si476x_core *, struct si476x_acf_status_report *); int si476x_core_cmd_agc_status(struct si476x_core *, struct si476x_agc_status_report *); enum si476x_power_grid_type { … }; /* Properties */ enum si476x_interrupt_flags { … }; enum si476x_rdsint_sources { … }; enum si476x_status_response_bits { … }; /* -------------------- si476x-prop.c ----------------------- */ enum si476x_common_receiver_properties { … }; enum si476x_am_receiver_properties { … }; enum si476x_fm_receiver_properties { … }; enum si476x_prop_audio_pwr_line_filter_bits { … }; enum si476x_prop_fm_rds_config_bits { … }; struct regmap *devm_regmap_init_si476x(struct si476x_core *); #endif /* SI476X_CORE_H */
Codebase Browser
linux