4

I have started learning STM32 programming in HAL and I am confused about what this function exactly does:

__weak void HAL_GPIO_EXTI_Callback(uint16_t GPIO_Pin) {
  /* Prevent unused argument(s) compilation warning */
  UNUSED(GPIO_Pin);
  /* NOTE: This function should not be modified, when the
  callback is needed, the HAL_GPIO_EXTI_Callback could be
  implemented in the user file
  */
}

What is the significance of the keyword (I am not sure if it's actually a keyword) __weak here and where do you use it? I saw a video where the lecturer said something about it but I did not understand.

ocrdu
  • 8,705
  • 21
  • 30
  • 42
user8737703
  • 51
  • 5

3 Answers3

11

The __weak keyword means that the function can be overridden by creating another function with the same declaration.

Many of the interrupt-functions etc. in the STM HAL libraries are declared as weak so that you can override them with your own function, instead of modifying the library functions.

From GCC Manual:

weak
The weak attribute causes the declaration to be emitted as a weak symbol rather than a global. This is primarily useful in defining library functions which can be overridden in user code, though it can also be used with non-function declarations.

Klas-Kenny
  • 4,283
  • 5
  • 24
  • So it's the moral equivalent of a C++ `virtual` class method, sounds like? "Insert implementation here." (But unlike `virtual` methods, the user (or _someone_) isn't **required** to supply an implementation. So, somewhere between a non-`final` method that can be replaced with an `override`, and a `virtual` placeholder that _**needs**_ to be replaced with an implementation.) – FeRD Dec 31 '21 at 23:46
  • 2
    @FeRD sort of yeah, except it's just linker magic. Normally if there are two definitions of a symbol you get an error. But if one is weak and one isn't, the "strong" definition wins, with no complaint. – hobbs Jan 01 '22 at 03:10
  • 1
    The function is not overwritten. The linker is choosing this function or function with the same name but having a strong linkage. It is done during the linking stage and the compiler is not involved here – 0___________ Jan 02 '22 at 00:13
8

As explained in this stackexchange question a function defined as "_weak" can be overwritten by a user-defined function with the same name.
It basically is a default function. If you don't write your own, the compiler will use the weak one. If you do define your own function with the same name, the compiler will ignore the weak one.

jusaca
  • 8,749
  • 4
  • 36
  • 58
5

It has nothing to do with STM32 or embedded programming.

It's just a compiler dependent extension to tell the C compiler that an object is weakly declared, as by default objects are strongly declared.

The example posted is just a way for the HAL to provide a default implementation of a function if the user does not write a function with the same name to override the default weak implementation.

Justme
  • 127,425
  • 3
  • 97
  • 261
  • instead of adding things to the function and redefining it, can we not just pass arguments to the function as per our application? – user8737703 Dec 31 '21 at 10:51
  • 1
    I don't follow what you ask. The HAL code requires that there is a function so it can be compiled. So if you use HAL and don't provide this function, you can't compile it due to missing function. That is why the HAL provides a default function so it can be compiled without you providing a function even if you don't need it, and if you need it then provide the function yourself. – Justme Dec 31 '21 at 10:58
  • here is what I understood: we can make changes or make additions to the function defined with the keyword "__weak" . But when we want to use the modified version of that function, we should not use the keyword "__weak", it tells the compiler "hey, if you find the function with same name, compile the one which does not have the keyword "__weak". Have I understood it right? – user8737703 Dec 31 '21 at 11:02
  • 4
    Have you read the HAL user manual? Have you read the NOTE in the code you quoted? The philosophy is that you provide the function, and you are supposed to use the HAL as given, instead of making changes into HAL files. – Justme Dec 31 '21 at 11:10
  • 1
    @user8737703 no, you're making it too complicated. There is no "modified version of the function". You just define a callback if you need one, or you don't if you don't. – hobbs Jan 01 '22 at 03:12