xref: /openbmc/u-boot/doc/README.bus_vcxk (revision 83d290c56fab2d38cd1ab4c4cc7099559c1d5046)
1*83d290c5STom RiniSPDX-License-Identifier: GPL-2.0+
250217deeSJens Scharsig/*
350217deeSJens Scharsig * (C) Copyright 2008-2009
450217deeSJens Scharsig * BuS Elektronik GmbH & Co. KG <www.bus-elektronik.de>
550217deeSJens Scharsig * Jens Scharsig <esw@bus-elektronik.de>
650217deeSJens Scharsig */
750217deeSJens Scharsig
850217deeSJens ScharsigU-Boot vcxk video controller driver
950217deeSJens Scharsig======================================
1050217deeSJens Scharsig
1150217deeSJens ScharsigBy defining CONFIG_VIDEO_VCXK this driver can be used with VC2K, VC4K and
1250217deeSJens ScharsigVC8K devices on following boards:
1350217deeSJens Scharsig
1450217deeSJens Scharsigboard           | ARCH          | Vendor
1550217deeSJens Scharsig-----------------------------------------------------------------------
1650217deeSJens ScharsigEB+CPU5282-T1   | MCF5282       | BuS Elektronik GmbH & Co. KG
1750217deeSJens ScharsigEB+MCF-EVB123   | MCF5282       | BuS Elektronik GmbH & Co. KG
1850217deeSJens ScharsigEB+CPUx9K2      | AT91RM9200    | BuS Elektronik GmbH & Co. KG
1950217deeSJens ScharsigZLSA            | AT91RM9200    | Ruf Telematik AG
2050217deeSJens Scharsig
2150217deeSJens ScharsigDriver configuration
2250217deeSJens Scharsig--------------------
2350217deeSJens Scharsig
2450217deeSJens ScharsigThe driver needs some defines to describe the target hardware:
2550217deeSJens Scharsig
2650217deeSJens ScharsigCONFIG_SYS_VCXK_BASE
2750217deeSJens Scharsig
2850217deeSJens Scharsig	base address of VCxK hardware memory
2950217deeSJens Scharsig
3050217deeSJens ScharsigCONFIG_SYS_VCXK_DEFAULT_LINEALIGN
3150217deeSJens Scharsig
3250217deeSJens Scharsig	defines the physical alignment of a pixel row
3350217deeSJens Scharsig
3450217deeSJens ScharsigCONFIG_SYS_VCXK_DOUBLEBUFFERED
3550217deeSJens Scharsig
3650217deeSJens Scharsig	some boards that use vcxk prevent read from framebuffer memory.
3750217deeSJens Scharsig	define this option to enable double buffering (needs 16KiB RAM)
3850217deeSJens Scharsig
3950217deeSJens ScharsigCONFIG_SYS_VCXK_<xxxx>_PIN
4050217deeSJens Scharsig
4150217deeSJens Scharsig	defines the number of the I/O line PIN in the port
4250217deeSJens Scharsig	valid values for <xxxx> are:
4350217deeSJens Scharsig
4450217deeSJens Scharsig		ACKNOWLEDGE
4550217deeSJens Scharsig			describes the acknowledge line from vcxk hardware
4650217deeSJens Scharsig
4750217deeSJens Scharsig		ENABLE
4850217deeSJens Scharsig			describes the enable line to vcxk hardware
4950217deeSJens Scharsig
5050217deeSJens Scharsig		INVERT
5150217deeSJens Scharsig			describes the invert line to vcxk hardware
5250217deeSJens Scharsig
5350217deeSJens Scharsig		RESET
5450217deeSJens Scharsig			describes the reset line to vcxk hardware
5550217deeSJens Scharsig
5650217deeSJens Scharsig		REQUEST
5750217deeSJens Scharsig			describes the request line to vcxk hardware
5850217deeSJens Scharsig
5950217deeSJens ScharsigCONFIG_SYS_VCXK_<xxxx>_PORT
6050217deeSJens Scharsig
6150217deeSJens Scharsig	defines the I/O port which is connected with the line
6250217deeSJens Scharsig	for valid values for <xxxx> see CONFIG_SYS_VCXK_<xxxx>_PIN
6350217deeSJens Scharsig
6450217deeSJens ScharsigCONFIG_SYS_VCXK_<xxxx>_DDR
6550217deeSJens Scharsig
6650217deeSJens Scharsig	defines the register which configures the direction
6750217deeSJens Scharsig	for valid values for <xxxx> see CONFIG_SYS_VCXK_<xxxx>_PIN
68