[linux.git] / include / media / soc_mediabus.h

/*
 * SoC-camera Media Bus API extensions
 *
 * Copyright (C) 2009, Guennadi Liakhovetski <[email protected]>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#ifndef SOC_MEDIABUS_H
#define SOC_MEDIABUS_H

#include <linux/videodev2.h>

#include <media/v4l2-mediabus.h>

/**
 * enum soc_mbus_packing - data packing types on the media-bus
 * @SOC_MBUS_PACKING_NONE:	no packing, bit-for-bit transfer to RAM
 * @SOC_MBUS_PACKING_2X8_PADHI:	16 bits transferred in 2 8-bit samples, in the
 *				possibly incomplete byte high bits are padding
 * @SOC_MBUS_PACKING_2X8_PADLO:	as above, but low bits are padding
 * @SOC_MBUS_PACKING_EXTEND16:	sample width (e.g., 10 bits) has to be extended
 *				to 16 bits
 */
enum soc_mbus_packing {
	SOC_MBUS_PACKING_NONE,
	SOC_MBUS_PACKING_2X8_PADHI,
	SOC_MBUS_PACKING_2X8_PADLO,
	SOC_MBUS_PACKING_EXTEND16,
};

/**
 * enum soc_mbus_order - sample order on the media bus
 * @SOC_MBUS_ORDER_LE:		least significant sample first
 * @SOC_MBUS_ORDER_BE:		most significant sample first
 */
enum soc_mbus_order {
	SOC_MBUS_ORDER_LE,
	SOC_MBUS_ORDER_BE,
};

/**
 * struct soc_mbus_pixelfmt - Data format on the media bus
 * @name:		Name of the format
 * @fourcc:		Fourcc code, that will be obtained if the data is
 *			stored in memory in the following way:
 * @packing:		Type of sample-packing, that has to be used
 * @order:		Sample order when storing in memory
 * @bits_per_sample:	How many bits the bridge has to sample
 */
struct soc_mbus_pixelfmt {
	const char		*name;
	u32			fourcc;
	enum soc_mbus_packing	packing;
	enum soc_mbus_order	order;
	u8			bits_per_sample;
};

const struct soc_mbus_pixelfmt *soc_mbus_get_fmtdesc(
	enum v4l2_mbus_pixelcode code);
s32 soc_mbus_bytes_per_line(u32 width, const struct soc_mbus_pixelfmt *mf);

#endif
Commit	Line	Data
9a74251d GL	1	/*
	2	* SoC-camera Media Bus API extensions
	3	*
	4	* Copyright (C) 2009, Guennadi Liakhovetski <[email protected]>
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License version 2 as
	8	* published by the Free Software Foundation.
	9	*/
	10
	11	#ifndef SOC_MEDIABUS_H
	12	#define SOC_MEDIABUS_H
	13
	14	#include <linux/videodev2.h>
	15
	16	#include <media/v4l2-mediabus.h>
	17
	18	/**
	19	* enum soc_mbus_packing - data packing types on the media-bus
	20	* @SOC_MBUS_PACKING_NONE: no packing, bit-for-bit transfer to RAM
	21	* @SOC_MBUS_PACKING_2X8_PADHI: 16 bits transferred in 2 8-bit samples, in the
	22	* possibly incomplete byte high bits are padding
	23	* @SOC_MBUS_PACKING_2X8_PADLO: as above, but low bits are padding
	24	* @SOC_MBUS_PACKING_EXTEND16: sample width (e.g., 10 bits) has to be extended
	25	* to 16 bits
	26	*/
	27	enum soc_mbus_packing {
	28	SOC_MBUS_PACKING_NONE,
	29	SOC_MBUS_PACKING_2X8_PADHI,
	30	SOC_MBUS_PACKING_2X8_PADLO,
	31	SOC_MBUS_PACKING_EXTEND16,
	32	};
	33
	34	/**
	35	* enum soc_mbus_order - sample order on the media bus
	36	* @SOC_MBUS_ORDER_LE: least significant sample first
	37	* @SOC_MBUS_ORDER_BE: most significant sample first
	38	*/
	39	enum soc_mbus_order {
	40	SOC_MBUS_ORDER_LE,
	41	SOC_MBUS_ORDER_BE,
	42	};
	43
	44	/**
	45	* struct soc_mbus_pixelfmt - Data format on the media bus
	46	* @name: Name of the format
	47	* @fourcc: Fourcc code, that will be obtained if the data is
	48	* stored in memory in the following way:
	49	* @packing: Type of sample-packing, that has to be used
	50	* @order: Sample order when storing in memory
	51	* @bits_per_sample: How many bits the bridge has to sample
	52	*/
	53	struct soc_mbus_pixelfmt {
	54	const char *name;
	55	u32 fourcc;
	56	enum soc_mbus_packing packing;
	57	enum soc_mbus_order order;
	58	u8 bits_per_sample;
	59	};
	60
	61	const struct soc_mbus_pixelfmt *soc_mbus_get_fmtdesc(
	62	enum v4l2_mbus_pixelcode code);
	63	s32 soc_mbus_bytes_per_line(u32 width, const struct soc_mbus_pixelfmt *mf);
	64
65	#endif