STM32CubeMX Hall Driver , documentation?

[astrid]

Posted on November 02, 2015 at 19:27

I acquainted

with

STM32CubeMX amd HAL Drivers for STM32F1,

but I'm really

some confused

.

For example SPI

in HAL Drivers User Manual I find function HAL_SPI_Transmit()

The thirdy parameters is Timeout

Documentation say Timeout is Timeout duration ,

of

what?

Why and how

OK I loot in function definition in line 400 of the xxxxx_SPI.c

Timeout is used as parametrs in function  SPI_WaitOnFlagUntilTimeout()

Unfortunately,

the documentation

again

say Timout duration and on line 2286 is Timout compared with HAL_MAX_DE''AY.

What

is

HAL_MAX_DELAY

I

could find

so far

.

Documentation

is a

bad joke

.

Is there any

better

documentation

and

examples

described

above 

function

parameters

?

Rr

how you

can

become familiar

with the

HAL

layer

Drivers

?

#use-the-source-luke

[Tesla DeLorean]

Posted on November 02, 2015 at 20:37

The HAL uses a 1ms SysTick to effect all it's delays and timeouts, I'd start assuming it's in milliseconds.

[Nickname5522_O]

Posted on November 03, 2015 at 11:24

Hi mark.aster,

In 

http://www.st.com/st-web-ui/static/active/en/resource/technical/document/user_manual/DM00154093.pdf

 section 2.12.4 (Timeout and error management), there is an explication for timeout and HAL_MAX_DELAY.

''The timeout is often used for the APIs that operate in polling mode. It defines the delay

during which a blocking process should wait till an error is returned.''

Hope this can help :)

-Shahrzad-

[astrid]

Posted on November 03, 2015 at 15:41

Thank you

UM1850 User manual Description of STM32F1xx HAL drivers

It is probably

what

I missed

.

Should

be an integral part

of stm32cube_fw_f1_v120.zip

[Nickname5522_O]

Posted on November 03, 2015 at 18:39

Hi mark.aster,

All documentation is available under the official page of

http://www.st.com/web/catalog/tools/FM147/CL1794/SC961/SS1743/LN1897/PF260820?s_searchtype=partnumber

Good luck :)

-Shahrzad-