Host integration

TFT LCD Software Integration Checklist: Verify the Support Package Before Hardware Freeze

A display that matches your interface can still cost weeks of software work. The question to settle before the hardware is frozen is not whether a driver exists somewhere, but who provides it, for which version, under what terms and with what evidence that it works on your board.

Illustrative embedded board, TFT display and laptop console for host integration
Conceptual bench setup. Software integration is checked on your own host, not inferred from a datasheet.
Quick answer. Split the software into three layers: the panel and its display link, any bridge or controller board, and the touch controller. For each one, record the operating system and board-support versions, where the driver and initialization data come from, who maintains them, the license and how to rebuild them. Mark every item as provided, customer responsibility or to be confirmed. Do not treat a community driver as a supplier commitment, and collect bring-up, reboot and recovery evidence on your own host.

Hardware reviews are well understood: the connector, the pinout, the voltages and the mechanical drawing. Software reviews are often skipped until the first boards arrive, and then a display that "supports MIPI DSI" or "supports LVDS" turns out to need an initialization sequence nobody has, a driver for a kernel version nobody uses or a touch controller that needs a firmware file with unclear rights.

This guide is a checklist for that conversation. It is not a register tutorial and it does not repeat the memory arithmetic covered in the framebuffer memory guide. The hardware and firmware boundary of controller boards is covered in the controller board guide, and the lane and initialization data for MIPI in the MIPI DSI guide. It does not state that any package, operating system or processor is supported.

Three software layers and who owns each

"The display driver" is really up to three separate pieces of software. They are maintained by different parties, change at different times and fail in different ways.

Conceptual host connected to panel, bridge and touch review paths, with blank callout boxes for project responsibilities
Simplified layer diagram. Your product may have fewer layers or more.
What each layer has to carry. Linux is used for the examples; other systems hold the same information in different places.
LayerWhat the software must provideExamples of where it lives
Panel and display linkTimings, bus format and polarity; for LVDS, the data mapping; for MIPI DSI, lane count, pixel format, mode flags and a panel initialization command sequence; power-up and reset delays; backlight enable and brightness controlA device-tree entry, a panel driver, a timing table or an initialization data file
Bridge or controller boardConfiguration of the converter chip or board, and its own firmware if it has oneThe bridge driver, a register table or a firmware image on the board
Touch controllerThe bus (often I²C or USB), address, interrupt and reset lines, coordinate orientation and any firmware or configuration blobA touch driver, a device-tree entry and a configuration file

Linux v6.12 provides concrete examples, not support commitments for the modules on this site. Its LVDS data-mapping schema enumerates jeida-18, jeida-24 and vesa-24; the applicable panel binding determines which properties are required. The simple-panel driver uses timing, bus-format, physical-size and prepare/enable/disable/unprepare-delay fields. The ST7703 DSI driver contains panel-specific initialization, lane, pixel-format and mode settings with power/reset handling. Use these examples to identify information to obtain from the exact panel and host documents, not to copy an unrelated sequence or presume driver compatibility.

Distinguish the display link from the touch link. They are different interfaces with different drivers, and a working picture says nothing about touch. Read the interface guide for the link types.

Freeze the OS, BSP, driver and initialization versions

A driver is only "supported" for a specific software baseline. Write the baseline down at the start and freeze it, so that a later change to the kernel, SDK or initialization data is a decision and not an accident. The table below is a checklist template. Its status column is left empty on purpose.

How to use the status column. Mark each row Provided only when you hold the file or the written statement, Customer when your team is responsible for it, and To be confirmed for everything else. This is a blank template. It is not a statement that TFTWorks provides any of these items for any model.
Software handoff checklist. Template only; the status and notes columns are for you to complete.
ItemWhat to recordStatusNotes and source
Operating system or RTOSName and exact version  
Board support package or SDKName, version and who supplies it  
Kernel or graphics stack versionVersion and the tree it comes from (mainline, vendor tree or your own)  
Panel driver or timing entrySource, version, maintainer and whether it was tested on this exact panel  
Initialization sequenceSource file, revision and who issued it; whether it matches the module revision you approved  
LVDS data mapping or DSI parametersJEIDA or VESA and bit depth; lanes, pixel format and mode flags  
Bridge or controller-board configurationDriver or register table, firmware version  
Touch driver and configurationDriver source, firmware or configuration file and its version  
Backlight controlEnable and brightness method, PWM or analog path, default level at boot  
Device-tree or configuration fileRevision of the file that ties the above together  
Orientation and coordinatesDisplay rotation and touch axis mapping  
Build instructionsToolchain, commands and a clean rebuild result  

Tie the initialization sequence to the module revision. If the module changes, the sequence may need to change with it; the PCN and revision control guide shows how to keep the approved record and recheck after a change.

Check the build, the license and the maintainer

Having the files is not the same as being able to use them. Four questions separate a handoff from a pile of source:

A community driver is not supplier support. Record it as To be confirmed until the supplier states in writing, for your exact configuration, what it supports and who fixes problems.

Put bring-up, reboot and recovery evidence in the handoff

A picture on someone else's bench proves little about yours. Collect evidence on your own hardware, with the frozen software baseline, and attach it to the checklist.

Bench setup with an embedded board on a relay power switch, a serial adapter cable and a camera on a tripod recording a lit display
Illustrative evidence setup. A repeatable power cycle and a recording are what make the result checkable.
Evidence to attach to the handoff
EvidenceHow to collect itWhat it shows
First imageBring up the display on the target board and capture the power-up sequence and console logInitial bring-up evidence for the documented host and conditions, not proof that every timing or operating condition is qualified
Orientation and touchDisplay a known pattern with corner markers and touch each cornerObserved rotation and coordinate behavior for the agreed check points
Cold boot repeatsPower-cycle from off many times and record each result; set the count in your test planObserved startup outcomes for the agreed cycle count and conditions; this does not establish a general failure rate
Warm rebootReboot without removing powerObserved warm-reboot behavior in the tested configuration
RecoveryRemove power during operation, and wake from sleep if the product sleepsObserved recovery behavior against agreed criteria, including any required manual action or unresolved failure
Backlight and brightnessCheck boot level, minimum and maximum, and changes while runningThat the backlight path works as the design assumes; see the dimming guide
Versions usedRecord the exact software and initialization revisions in the logThat the evidence can be repeated

If a step fails, the troubleshooting order in the interface troubleshooting guide helps decide whether the cause is the link, the timing or the power sequence before you start rewriting software.

Questions to ask the supplier

  1. For my processor, operating system and exact version, is there a driver, a configuration entry or an initialization file, and is it tested on this module?
  2. Who issued the initialization sequence, and does it match the module revision I would approve?
  3. Is the software available as source, and under what license?
  4. Who maintains it, how are bugs reported and what support period applies?
  5. If the module uses a bridge or controller board, what firmware does it need and who owns it?
  6. Which touch controller is used, and what driver, firmware or configuration does it need?
  7. What happens to the software if the module revision changes?
  8. Which items are my responsibility, and which can the supplier confirm in writing?

Send the answers together with your host part number, operating system and version, board support package, the source of any existing driver, the display and touch models and the project stage through a host integration review, so the software questions are checked against your actual baseline.

Software integration FAQ

What software does a TFT LCD module need on the host?

The module is not software you install, but the host has to be configured for it. That usually means display timing and bus format, for LVDS the data mapping, for MIPI DSI the lane count, pixel format and an initialization command sequence, plus power sequencing, backlight control and a separate driver or configuration for the touch controller. If a bridge or controller board is used, it has its own configuration too.

Do I have to write a display driver myself?

It depends on the interface, the operating system and the version. Panels described by timing and bus format may need only a configuration entry in some display frameworks, while some DSI panels require panel-specific initialization in a driver. Ask whether a driver or configuration for your exact OS and BSP version exists, who maintains it and under what license.

Is a community or mainline driver the same as supplier support?

No. A community or mainline driver can be a useful reference, but fixes, version compatibility and support are not a supplier commitment unless the supplier states them in writing for your configuration. Record it as an unconfirmed item until it is confirmed.

What evidence should I collect before hardware freeze?

Collect the first image on your target hardware with the power sequence captured, correct orientation and touch coordinates, repeated cold boots and warm reboots, recovery after an unexpected power loss or sleep, and the exact software versions used. Evidence from a different host or software version does not prove your own.

Technical references

Connect the software baseline to the module and test plan

Use the 7-inch LVDS connection review to request the exact mapping and cable documents. For a native portrait MIPI candidate, review DS-T101BYEA-01ND and request the applicable initialization and host requirements; the link is not a claim that a Linux driver or BSP is supplied.

Freeze a known image source before applying the pixel-defect inspection criterion or the static-HMI retention test. Keep the evidence tied to the approved module, host and software revisions rather than reuse another project's results.

Send Us Your Host and Software Baseline

Share the host part number, the operating system or RTOS and version, the board support package, where any existing driver comes from, the display and touch models and the project stage. TFTWorks can review the published information against that configuration and tell you what needs confirming.

Request a Project Review   Read the controller board guide

Send supporting files with the same project reference

The web form does not upload attachments. Email drawings, configuration records or test requirements

You can also send files through WhatsApp. Include the same model and project reference as your enquiry.

Publisher and scope. Published by TFTWorks, operated by Guangdong Dexing Microelectronics Co., Ltd. This guide describes a general method and does not state that any TFTWorks module is supported by any operating system, processor or driver, or that any software package is provided. The Linux material is an example of how such information is expressed, and the template is not a record of any real handoff. Confirm software availability, versions and terms against the current model-specific documents and in writing.

View TFT ModulesRequest Review