TouchGFX documentation feedback

[Romain DIELEMAN]

We wish to always improve our documentation. The best reviews and critics always come from the people that read it, so we would like to use this post to collect your thoughts and feedbacks.

Please share what you like, dislike, what you think is missing, etc ...

/The TouchGFX team

[CommanderCloud]

https://support.touchgfx.com/docs/development/board-bring-up/how-to/03-display-internal

stm32f7xx_it.c

void LTDC_IRQHandler(void)
{
 /* USER CODE BEGIN LTDC_IRQn 0 */
 /* USER CODE END LTDC_IRQn 0 */
 HAL_LTDC_IRQHandler(&hltdc);
 /* USER CODE BEGIN LTDC_IRQn 1 */
 HAL_LTDC_ProgramLineEvent(&hltdc,0);
 /* USER CODE END LTDC_IRQn 1 */
}

Sample code doesn't work -

HAL_LTDC_ProgramLineEvent(&hltdc,0);

shouldn't be in there.

[RobNewbury]

I am developing an application using an external frame buffer so I hadn't looked too closely at this page for a frame buffer in internal RAM, however I think the need to re-enable the LCD interrupt once per frame is the same in both cases.

That said, I can't see what is wrong with the sample code? Could you be more specific please?  
My own code development for integrating a custom display with TouchGFX has been slow and I currently render a static screen so I haven't implemented this code (yet) but now it is drawn to my attention I am thinking of doing so.

[CommanderCloud]

Hello!

 

Sorry for not being specific. HAL_LTDC_ProgramLIneEvent is used in the HAL_LTDC_LineEventCallback function in TouchGFXGeneratedHAL.cpp. HAL_LTDC_ProgramLineEvent(LTDC_HandleTypeDef *hltdc, uint32_t Line) basically just sets LTDC->LIPCR equal to Line. LIPCR is used as a conditional in HAL_LTDC_LineEventCallback, and it needs to be set to a specific value as defined in that function. Setting it in the interrupt routine breaks the conditional and prevents this LineEventCallback from working properly, which breaks the Tick.

 

Kind regards, Cloud.

[RobNewbury]

Great explanation, thanks.

[mdalal]

First of all, the existing documentation is reasonable enough to understand the design principles behind TouchGFX and its features.

However, if we go one level depper as a developer, I believe that a major missing point is not having a sequence diagram for the application specific HAL implementataion and TouchGFX library inter module calls. Due to this, I have got the learning in a hard way by validating the sequence diagrams by manually debugging the code.

Kinldy note that I am not suggesting to have internal sequences that happen in the TouchGFX library as I know that cannot be shared. My request is between the HAL and Library.

[Muharrem]

Hello.

https://support.touchgfx.com/docs/development/development-introduction

Last words of this section:

"As the AT comes with an .ioc as well, you can open it and change the toolchain to match your needs."

What is AT?

 

[jchernus-fikst]

Never mind this reply, I was wrong and resolved my problem - documentation is fine!

[MPamenter]

The documentation is excellent so far!  I found a little spelling mistake in the board bring up section.

https://support.touchgfx.com/4.25/docs/development/board-bring-up/how-to/02-cpu-running#touchgfx-internal-dcache-state-machine

"majority" is written as "mijority"

[Southbranch]

Hi,

The documentation has become pretty good.

However, on my wishlist would be a section describing on how to use TouchGFX's built in APIs to track FPS and CPU usage in percentage in the same way as many board's demos have in their GUIs. Would be very helpful during prototyping.

Thanks

Overall, the TouchGFX documentation is quite well-structured and informative. But i got few suggestions 

 

1.  Include more practical examples

2.  Include a visual roadmap or workflow diagram

3.  Include Getting Started Checklist

[ARM_and]

a small suggestion:

Step 8 of board bring up, https://support.touchgfx.com/docs/development/board-bring-up/how-to/08-hardware-acceleration#write-to-framebuffer-memory is less prescriptive than the initial steps where the location of where to insert the code e.g. /* USER CODE BEGIN X */ where given. It leaves a bit of room for confusion.

 

 

 

[RobNewbury]

I notice that documentation for TouchGFX 4.25, section 'Video Decoding' has been thinned down. It no longer contains detailed information on the following sub-topics, other sub-topics are also missing.
* Software Decoding
* RTOS Support

Without this information, the software video decoder can't be properly setup for software decoding.
Has this information been moved elsewhere in the documentation? I don't see a link to it on the Video Decoding page.  

 

 

 

[RobNewbury]

Apologies, now I look closer I now see that I mistook the Video Decoding Section for the TouchGFX Generator with the Video Decoding section in 'Scenarios' which does contain all the necessary information.