linux/drivers/media/pci/cx18/cx18-driver.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 *  cx18 driver internal defines and structures
 *
 *  Derived from ivtv-driver.h
 *
 *  Copyright (C) 2007  Hans Verkuil <[email protected]>
 *  Copyright (C) 2008  Andy Walls <[email protected]>
 */

#ifndef CX18_DRIVER_H
#define CX18_DRIVER_H

#include <linux/module.h>
#include <linux/moduleparam.h>
#include <linux/init.h>
#include <linux/delay.h>
#include <linux/sched/signal.h>
#include <linux/fs.h>
#include <linux/pci.h>
#include <linux/interrupt.h>
#include <linux/spinlock.h>
#include <linux/i2c.h>
#include <linux/i2c-algo-bit.h>
#include <linux/list.h>
#include <linux/unistd.h>
#include <linux/pagemap.h>
#include <linux/workqueue.h>
#include <linux/mutex.h>
#include <linux/slab.h>
#include <asm/byteorder.h>

#include <media/v4l2-common.h>
#include <media/v4l2-ioctl.h>
#include <media/v4l2-device.h>
#include <media/v4l2-fh.h>
#include <media/tuner.h>
#include <media/i2c/ir-kbd-i2c.h>
#include "cx18-mailbox.h"
#include "cx18-av-core.h"
#include "cx23418.h"

/* DVB */
#include <media/demux.h>
#include <media/dmxdev.h>
#include <media/dvb_demux.h>
#include <media/dvb_frontend.h>
#include <media/dvb_net.h>
#include <media/dvbdev.h>

/* vb2 YUV support */
#include <media/videobuf2-vmalloc.h>

#ifndef CONFIG_PCI
#  error "This driver requires kernel PCI support."
#endif

#define CX18_MEM_OFFSET
#define CX18_MEM_SIZE
#define CX18_REG_OFFSET

/* Maximum cx18 driver instances. */
#define CX18_MAX_CARDS

/* Supported cards */
#define CX18_CARD_HVR_1600_ESMT
#define CX18_CARD_HVR_1600_SAMSUNG
#define CX18_CARD_COMPRO_H900
#define CX18_CARD_YUAN_MPC718
#define CX18_CARD_CNXT_RAPTOR_PAL
#define CX18_CARD_TOSHIBA_QOSMIO_DVBT
#define CX18_CARD_LEADTEK_PVR2100
#define CX18_CARD_LEADTEK_DVR3100H
#define CX18_CARD_GOTVIEW_PCI_DVD3
#define CX18_CARD_HVR_1600_S5H1411
#define CX18_CARD_LAST

#define CX18_ENC_STREAM_TYPE_MPG
#define CX18_ENC_STREAM_TYPE_TS
#define CX18_ENC_STREAM_TYPE_YUV
#define CX18_ENC_STREAM_TYPE_VBI
#define CX18_ENC_STREAM_TYPE_PCM
#define CX18_ENC_STREAM_TYPE_IDX
#define CX18_ENC_STREAM_TYPE_RAD
#define CX18_MAX_STREAMS

/* system vendor and device IDs */
#define PCI_VENDOR_ID_CX
#define PCI_DEVICE_ID_CX23418

/* subsystem vendor ID */
#define CX18_PCI_ID_HAUPPAUGE
#define CX18_PCI_ID_COMPRO
#define CX18_PCI_ID_YUAN
#define CX18_PCI_ID_CONEXANT
#define CX18_PCI_ID_TOSHIBA
#define CX18_PCI_ID_LEADTEK
#define CX18_PCI_ID_GOTVIEW

/* ======================================================================== */
/* ========================== START USER SETTABLE DMA VARIABLES =========== */
/* ======================================================================== */

/* DMA Buffers, Default size in MB allocated */
#define CX18_DEFAULT_ENC_TS_BUFFERS
#define CX18_DEFAULT_ENC_MPG_BUFFERS
#define CX18_DEFAULT_ENC_IDX_BUFFERS
#define CX18_DEFAULT_ENC_YUV_BUFFERS
#define CX18_DEFAULT_ENC_VBI_BUFFERS
#define CX18_DEFAULT_ENC_PCM_BUFFERS

/* Maximum firmware DMA buffers per stream */
#define CX18_MAX_FW_MDLS_PER_STREAM

/* YUV buffer sizes in bytes to ensure integer # of frames per buffer */
#define CX18_UNIT_ENC_YUV_BUFSIZE
#define CX18_625_LINE_ENC_YUV_BUFSIZE
#define CX18_525_LINE_ENC_YUV_BUFSIZE

/* IDX buffer size should be a multiple of the index entry size from the chip */
struct cx18_enc_idx_entry {} __attribute__ ((packed));
#define CX18_UNIT_ENC_IDX_BUFSIZE

/* DMA buffer, default size in kB allocated */
#define CX18_DEFAULT_ENC_TS_BUFSIZE
#define CX18_DEFAULT_ENC_MPG_BUFSIZE
#define CX18_DEFAULT_ENC_IDX_BUFSIZE
#define CX18_DEFAULT_ENC_YUV_BUFSIZE
#define CX18_DEFAULT_ENC_PCM_BUFSIZE

/* i2c stuff */
#define I2C_CLIENTS_MAX

/* debugging */

/* Flag to turn on high volume debugging */
#define CX18_DBGFLG_WARN
#define CX18_DBGFLG_INFO
#define CX18_DBGFLG_API
#define CX18_DBGFLG_DMA
#define CX18_DBGFLG_IOCTL
#define CX18_DBGFLG_FILE
#define CX18_DBGFLG_I2C
#define CX18_DBGFLG_IRQ
/* Flag to turn on high volume debugging */
#define CX18_DBGFLG_HIGHVOL

/* NOTE: extra space before comma in 'fmt , ## args' is required for
   gcc-2.95, otherwise it won't compile. */
#define CX18_DEBUG(x, type, fmt, args...)
#define CX18_DEBUG_WARN(fmt, args...)
#define CX18_DEBUG_INFO(fmt, args...)
#define CX18_DEBUG_API(fmt, args...)
#define CX18_DEBUG_DMA(fmt, args...)
#define CX18_DEBUG_IOCTL(fmt, args...)
#define CX18_DEBUG_FILE(fmt, args...)
#define CX18_DEBUG_I2C(fmt, args...)
#define CX18_DEBUG_IRQ(fmt, args...)

#define CX18_DEBUG_HIGH_VOL(x, type, fmt, args...)
#define CX18_DEBUG_HI_WARN(fmt, args...)
#define CX18_DEBUG_HI_INFO(fmt, args...)
#define CX18_DEBUG_HI_API(fmt, args...)
#define CX18_DEBUG_HI_DMA(fmt, args...)
#define CX18_DEBUG_HI_IOCTL(fmt, args...)
#define CX18_DEBUG_HI_FILE(fmt, args...)
#define CX18_DEBUG_HI_I2C(fmt, args...)
#define CX18_DEBUG_HI_IRQ(fmt, args...)

/* Standard kernel messages */
#define CX18_ERR(fmt, args...)
#define CX18_WARN(fmt, args...)
#define CX18_INFO(fmt, args...)

/* Messages for internal subdevs to use */
#define CX18_DEBUG_DEV(x, dev, type, fmt, args...)
#define CX18_DEBUG_WARN_DEV(dev, fmt, args...)
#define CX18_DEBUG_INFO_DEV(dev, fmt, args...)
#define CX18_DEBUG_API_DEV(dev, fmt, args...)
#define CX18_DEBUG_DMA_DEV(dev, fmt, args...)
#define CX18_DEBUG_IOCTL_DEV(dev, fmt, args...)
#define CX18_DEBUG_FILE_DEV(dev, fmt, args...)
#define CX18_DEBUG_I2C_DEV(dev, fmt, args...)
#define CX18_DEBUG_IRQ_DEV(dev, fmt, args...)

#define CX18_DEBUG_HIGH_VOL_DEV(x, dev, type, fmt, args...)
#define CX18_DEBUG_HI_WARN_DEV(dev, fmt, args...)
#define CX18_DEBUG_HI_INFO_DEV(dev, fmt, args...)
#define CX18_DEBUG_HI_API_DEV(dev, fmt, args...)
#define CX18_DEBUG_HI_DMA_DEV(dev, fmt, args...)
#define CX18_DEBUG_HI_IOCTL_DEV(dev, fmt, args...)
#define CX18_DEBUG_HI_FILE_DEV(dev, fmt, args...)
#define CX18_DEBUG_HI_I2C_DEV(dev, fmt, args...)
#define CX18_DEBUG_HI_IRQ_DEV(dev, fmt, args...)

#define CX18_ERR_DEV(dev, fmt, args...)
#define CX18_WARN_DEV(dev, fmt, args...)
#define CX18_INFO_DEV(dev, fmt, args...)

extern int cx18_debug;

struct cx18_options {};

/* per-mdl bit flags */
#define CX18_F_M_NEED_SWAP

/* per-stream, s_flags */
#define CX18_F_S_CLAIMED
#define CX18_F_S_STREAMING
#define CX18_F_S_INTERNAL_USE
#define CX18_F_S_STREAMOFF
#define CX18_F_S_APPL_IO
#define CX18_F_S_STOPPING

/* per-cx18, i_flags */
#define CX18_F_I_LOADED_FW
#define CX18_F_I_EOS
#define CX18_F_I_RADIO_USER
#define CX18_F_I_ENC_PAUSED
#define CX18_F_I_INITED
#define CX18_F_I_FAILED

/* These are the VBI types as they appear in the embedded VBI private packets. */
#define CX18_SLICED_TYPE_TELETEXT_B
#define CX18_SLICED_TYPE_CAPTION_525
#define CX18_SLICED_TYPE_WSS_625
#define CX18_SLICED_TYPE_VPS

/**
 * list_entry_is_past_end - check if a previous loop cursor is off list end
 * @pos:	the type * previously used as a loop cursor.
 * @head:	the head for your list.
 * @member:	the name of the list_head within the struct.
 *
 * Check if the entry's list_head is the head of the list, thus it's not a
 * real entry but was the loop cursor that walked past the end
 */
#define list_entry_is_past_end(pos, head, member)

struct cx18_vb2_buffer {};

struct cx18_buffer {};

struct cx18_mdl {};

struct cx18_queue {};

struct cx18_stream; /* forward reference */

struct cx18_dvb {};

struct cx18;	 /* forward reference */
struct cx18_scb; /* forward reference */


#define CX18_MAX_MDL_ACKS
#define CX18_MAX_IN_WORK_ORDERS
/* CPU_DE_RELEASE_MDL can burst CX18_MAX_FW_MDLS_PER_STREAM orders in a group */

#define CX18_F_EWO_MB_STALE_UPON_RECEIPT
#define CX18_F_EWO_MB_STALE_WHILE_PROC
#define CX18_F_EWO_MB_STALE

struct cx18_in_work_order {};

#define CX18_INVALID_TASK_HANDLE

struct cx18_stream {};

struct cx18_open_id {};

static inline struct cx18_open_id *fh2id(struct v4l2_fh *fh)
{}

static inline struct cx18_open_id *file2id(struct file *file)
{}

/* forward declaration of struct defined in cx18-cards.h */
struct cx18_card;

/*
 * A note about "sliced" VBI data as implemented in this driver:
 *
 * Currently we collect the sliced VBI in the form of Ancillary Data
 * packets, inserted by the AV core decoder/digitizer/slicer in the
 * horizontal blanking region of the VBI lines, in "raw" mode as far as
 * the Encoder is concerned.  We don't ever tell the Encoder itself
 * to provide sliced VBI. (AV Core: sliced mode - Encoder: raw mode)
 *
 * We then process the ancillary data ourselves to send the sliced data
 * to the user application directly or build up MPEG-2 private stream 1
 * packets to splice into (only!) MPEG-2 PS streams for the user app.
 *
 * (That's how ivtv essentially does it.)
 *
 * The Encoder should be able to extract certain sliced VBI data for
 * us and provide it in a separate stream or splice it into any type of
 * MPEG PS or TS stream, but this isn't implemented yet.
 */

/*
 * Number of "raw" VBI samples per horizontal line we tell the Encoder to
 * grab from the decoder/digitizer/slicer output for raw or sliced VBI.
 * It depends on the pixel clock and the horiz rate:
 *
 * (1/Fh)*(2*Fp) = Samples/line
 *     = 4 bytes EAV + Anc data in hblank + 4 bytes SAV + active samples
 *
 *  Sliced VBI data is sent as ancillary data during horizontal blanking
 *  Raw VBI is sent as active video samples during vertcal blanking
 *
 *  We use a  BT.656 pxiel clock of 13.5 MHz and a BT.656 active line
 *  length of 720 pixels @ 4:2:2 sampling.  Thus...
 *
 *  For systems that use a 15.734 kHz horizontal rate, such as
 *  NTSC-M, PAL-M, PAL-60, and other 60 Hz/525 line systems, we have:
 *
 *  (1/15.734 kHz) * 2 * 13.5 MHz = 1716 samples/line =
 *  4 bytes SAV + 268 bytes anc data + 4 bytes SAV + 1440 active samples
 *
 *  For systems that use a 15.625 kHz horizontal rate, such as
 *  PAL-B/G/H, PAL-I, SECAM-L and other 50 Hz/625 line systems, we have:
 *
 *  (1/15.625 kHz) * 2 * 13.5 MHz = 1728 samples/line =
 *  4 bytes SAV + 280 bytes anc data + 4 bytes SAV + 1440 active samples
 */
#define VBI_ACTIVE_SAMPLES
#define VBI_HBLANK_SAMPLES_60HZ
#define VBI_HBLANK_SAMPLES_50HZ

#define CX18_VBI_FRAMES

struct vbi_info {};

/* Per cx23418, per I2C bus private algo callback data */
struct cx18_i2c_algo_callback_data {};

#define CX18_MAX_MMIO_WR_RETRIES

/* Struct to hold info about cx18 cards */
struct cx18 {};

static inline struct cx18 *to_cx18(struct v4l2_device *v4l2_dev)
{}

/* cx18 extensions to be loaded */
extern int (*cx18_ext_init)(struct cx18 *);

/* Globals */
extern int cx18_first_minor;

/*==============Prototypes==================*/

/* Return non-zero if a signal is pending */
int cx18_msleep_timeout(unsigned int msecs, int intr);

/* Read Hauppauge eeprom */
struct tveeprom; /* forward reference */
void cx18_read_eeprom(struct cx18 *cx, struct tveeprom *tv);

/* First-open initialization: load firmware, etc. */
int cx18_init_on_first_open(struct cx18 *cx);

/* Test if the current VBI mode is raw (1) or sliced (0) */
static inline int cx18_raw_vbi(const struct cx18 *cx)
{}

/* Call the specified callback for all subdevs with a grp_id bit matching the
 * mask in hw (if 0, then match them all). Ignore any errors. */
#define cx18_call_hw(cx, hw, o, f, args...)

#define cx18_call_all(cx, o, f, args...)

/* Call the specified callback for all subdevs with a grp_id bit matching the
 * mask in hw (if 0, then match them all). If the callback returns an error
 * other than 0 or -ENOIOCTLCMD, then return with that error code. */
#define cx18_call_hw_err(cx, hw, o, f, args...)

#define cx18_call_all_err(cx, o, f, args...)

#endif /* CX18_DRIVER_H */