EINT

This section introduces the External Interrupt Controller(EINT) APIs including terms and acronyms, supported features, software architecture, details on how to use this driver, EINT function groups, enums, structures and functions. More...

Overview

This section introduces the External Interrupt Controller(EINT) APIs including terms and acronyms, supported features, software architecture, details on how to use this driver, EINT function groups, enums, structures and functions.

Terms and acronyms

Terms	Details
EINT	External Interrupt Controller. Process the interrupt request from an external source or peripheral.
GPIO	General Purpose Inputs-Outputs. For more information, please refer to GPIO module in HAL.
ISR	Interrupt service routine.
NVIC	Nested Vectored Interrupt Controller. NVIC is the interrupt controller of ARM Cortex-M4. For more details, please refer to NVIC introduction in ARM Cortex-M4 Processor Technical Reference Manual .

Supported features

The EINT controller has been designed to process interrupts from an external source or peripheral.

• Support callback function registration.
  Call hal_eint_clear_software_trigger() function to trigger an interrupt immediately after the EINT is unmasked.
  

Software architecture of EINT

For the architecture diagram please refer HAL Driver Model.

How to use this driver

• Use EINT.
  
  • Step 1: Call hal_gpio_init() to init the pins, if EPT tool hasn't been used to configure the related pinmux.
  • Step 2: Call hal_pinmux_set_function() to set the GPIO pinmux. For more information about hal_pinmux_set_function(), please refer to GPIO API reference.
  • Step 3: Call hal_eint_mask() mask to select an EINT source.
  • Step 4: Initialize the selected EINT source. Call hal_eint_init() to configue the EINT number's trigger mode and debounce time, or call hal_eint_set_trigger_mode() and hal_eint_set_debounce_time() to replace.
  • Step 5: Regist a callback function. Call hal_eint_register_callback() to register a user callback function.
  • Step 6: Unmask the EINT. Call hal_eint_unmask() to unmask the EINT.
  • Sample code:

    //Init GPIO, set GPIO pinmux(if EPT tool hasn't been used to configure the related pinmux).
    hal_gpio_init(HAL_GPIO_4);
    
    //Call hal_pinmux_set_function() to set GPIO pinmux, for more information, please reference hal_pinmux_define.h
    //function_index = HAL_GPIO_4_EINT3. Need not to configure pinmux if EPT tool is used.
    hal_pinmux_set_function(HAL_GPIO_4, function_index);
    
    hal_eint_mask(eint_number);
    if (HAL_EINT_STATUS_OK !=  hal_eint_init(eint_number, &eint_config)) {
            // error handle
    }
    if (HAL_EINT_STATUS_OK !=  hal_eint_register_callback(eint_number, callback, user_data)) {
            // error handle
    }
    
    // Change trigger mode or debounce time at runtime.
    hal_eint_mask(eint_number);
    if (HAL_EINT_STATUS_OK !=  hal_eint_set_trigger_mode(eint_number, trigger_mode)) {
            // error handle
    }
    if (HAL_EINT_STATUS_OK !=  hal_eint_set_debounce_time(eint_number, time_ms)) {
            // error handle
    }
    hal_eint_unmask(eint_number);

    // Callback function. This function should be registered with hal_eint_register_callback().
    void callback(void *user_data)
    {
        // Mask eint_number at here is optional as it had been masked in HAL EINT driver.
        hal_eint_mask(eint_number);
        // User's handler
        // Please call hal_eint_unmask() to unmask eint_number to receive an EINT interrupt.
        hal_eint_unmask(eint_number);
    }

Functions
hal_eint_status_t	hal_eint_init (hal_eint_number_t eint_number, const hal_eint_config_t *eint_config)
	This function initializes the EINT number, it sets the EINT trigger mode and debounce time. More...
hal_eint_status_t	hal_eint_deinit (hal_eint_number_t eint_number)
	This function deinitializes the EINT number, it resets the EINT trigger mode and debounce time. More...
hal_eint_status_t	hal_eint_register_callback (hal_eint_number_t eint_number, hal_eint_callback_t callback, void *user_data)
	This function registers a callback function for a specified EINT number. More...
hal_eint_status_t	hal_eint_set_trigger_mode (hal_eint_number_t eint_number, hal_eint_trigger_mode_t trigger_mode)
	This function sets the EINT number to a trigger mode. More...
hal_eint_status_t	hal_eint_set_debounce_time (hal_eint_number_t eint_number, uint32_t time_ms)
	This function sets the EINT debounce time. More...
hal_eint_status_t	hal_eint_set_software_trigger (hal_eint_number_t eint_number)
	This function triggers EINT software interrupt. More...
hal_eint_status_t	hal_eint_clear_software_trigger (hal_eint_number_t eint_number)
	This function clears the EINT software interrupt. More...
hal_eint_status_t	hal_eint_mask (hal_eint_number_t eint_number)
	This function masks the dedicated EINT source. More...
hal_eint_status_t	hal_eint_unmask (hal_eint_number_t eint_number)
	This function unmasks the dedicated EINT source. More...
hal_eint_status_t	hal_eint_set_debounce_count (hal_eint_number_t eint_number, uint32_t count)
	This function sets the EINT debounce count. More...

Modules
	Enum
	Struct
	Typedef

Function Documentation

hal_eint_status_t hal_eint_clear_software_trigger

(

hal_eint_number_t

eint_number

)

This function clears the EINT software interrupt.

Parameters

[in]

eint_number

is the EINT number, the value is from HAL_EINT_0 to HAL_EINT_MAX-1, please refer to hal_eint_number_t.

Returns

To indicate whether this function call is successful. If the return value is HAL_EINT_STATUS_OK, the operation completed successfully; If the return value is HAL_EINT_STATUS_INVALID_PARAMETER, a wrong parameter is given, the parameter must be verified.

See also

hal_eint_set_software_trigger()

Example

Sample code please refer to How to use this driver

hal_eint_status_t hal_eint_deinit

(

hal_eint_number_t

eint_number

)

This function deinitializes the EINT number, it resets the EINT trigger mode and debounce time.

Parameters

[in]

eint_number

is the EINT number, the value is HAL_EINT_0~HAL_EINT_MAX-1.

Returns

To indicate whether this function call is successful. If the return value is HAL_EINT_STATUS_OK, the operation completed successfully; If the return value is HAL_EINT_STATUS_INVALID_PARAMETER, a wrong parameter is given, the parameter must be verified.

See also

hal_eint_deinit()

Example

Sample code please refer to How to use this driver

hal_eint_status_t hal_eint_init	(	hal_eint_number_t	eint_number,
		const hal_eint_config_t *	eint_config
	)

This function initializes the EINT number, it sets the EINT trigger mode and debounce time.

Parameters

[in]	eint_number	is the EINT number, the value is HAL_EINT_0~HAL_EINT_MAX-1.
[in]	eint_config	is the initial configuration parameter. EINT debounce is disabled when debounce time is set to zero. For more details, please refer to hal_eint_config_t.

Returns

To indicate whether this function call is successful. If the return value is HAL_EINT_STATUS_OK, the operation completed successfully; If the return value is HAL_EINT_STATUS_INVALID_PARAMETER, a wrong parameter is given, the parameter must be verified.

See also

hal_eint_deinit()

Example

Sample code please refer to How to use this driver

hal_eint_status_t hal_eint_mask

(

hal_eint_number_t

eint_number

)

This function masks the dedicated EINT source.

Parameters

[in]

eint_number

is the EINT number, the value is from HAL_EINT_0 to HAL_EINT_MAX-1, please refer to hal_eint_number_t.

Returns

To indicate whether this function call is successful. If the return value is HAL_EINT_STATUS_OK, the operation completed successfully; If the return value is HAL_EINT_STATUS_INVALID_PARAMETER, a wrong parameter is given, the parameter must be verified.

See also

hal_eint_unmask

hal_eint_status_t hal_eint_register_callback	(	hal_eint_number_t	eint_number,
		hal_eint_callback_t	callback,
		void *	user_data
	)

This function registers a callback function for a specified EINT number.

Parameters

[in]	eint_number	is the EINT number, the value is HAL_EINT_0~HAL_EINT_MAX-1, please refer to hal_eint_number_t.
[in]	callback	is the function given by the user, which will be called at EINT ISR routine.
[in]	user_data	is a reserved parameter for user.

Returns

To indicate whether this function call is successful. If the return value is HAL_EINT_STATUS_OK, the operation completed successfully; If the return value is HAL_EINT_STATUS_INVALID_PARAMETER, a wrong parameter is given, the parameter must be verified.

See also

hal_eint_init()

Example

Sample code please refer to How to use this driver

hal_eint_status_t hal_eint_set_debounce_count	(	hal_eint_number_t	eint_number,
		uint32_t	count
	)

This function sets the EINT debounce count.

Parameters

[in]	eint_number	is the EINT number, the value is from HAL_EINT_0 to HAL_EINT_MAX-1, please refer to hal_eint_number_t.
[in]	count	is the EINT number's hardware debounce count in 32768 Hz. EINT debounce is disabled when count is set to zero.

Returns

To indicate whether this function call is successful. If the return value is HAL_EINT_STATUS_OK, the operation completed successfully; If the return value is HAL_EINT_STATUS_INVALID_PARAMETER, a wrong parameter is given, the parameter must be verified.

Example

Sample code please refer to How to use this driver

hal_eint_status_t hal_eint_set_debounce_time	(	hal_eint_number_t	eint_number,
		uint32_t	time_ms
	)

This function sets the EINT debounce time.

Parameters

[in]	eint_number	is the EINT number, the value is from HAL_EINT_0 to HAL_EINT_MAX-1, please refer to hal_eint_number_t.
[in]	time_ms	is the EINT number's hardware debounce time in milliseconds. EINT debounce is disabled when time_ms is set to zero.

Returns

To indicate whether this function call is successful. If the return value is HAL_EINT_STATUS_OK, the operation completed successfully; If the return value is HAL_EINT_STATUS_INVALID_PARAMETER, a wrong parameter is given, the parameter must be verified.

Example

Sample code please refer to How to use this driver

hal_eint_status_t hal_eint_set_software_trigger

(

hal_eint_number_t

eint_number

)

This function triggers EINT software interrupt.

Parameters

[in]

eint_number

is the EINT number, the value is from HAL_EINT_0 to HAL_EINT_MAX-1, please refer to hal_eint_number_t.

Returns

To indicate whether this function call is successful. If the return value is HAL_EINT_STATUS_OK, the operation completed successfully; If the return value is HAL_EINT_STATUS_INVALID_PARAMETER, a wrong parameter is given, the parameter must be verified.

See also

hal_eint_clear_software_trigger()

Example

Sample code please refer to How to use this driver

hal_eint_status_t hal_eint_set_trigger_mode	(	hal_eint_number_t	eint_number,
		hal_eint_trigger_mode_t	trigger_mode
	)

This function sets the EINT number to a trigger mode.

Parameters

[in]	eint_number	is the EINT number, the value is from HAL_EINT_0 to HAL_EINT_MAX-1, please refer to hal_eint_number_t.
[in]	trigger_mode	is EINT number trigger mode. For more details, please refer to hal_eint_trigger_mode_t.

Returns

To indicate whether this function call is successful. If the return value is HAL_EINT_STATUS_OK, the operation completed successfully; If the return value is HAL_EINT_STATUS_INVALID_PARAMETER, a wrong parameter is given, the parameter must be verified.

Example

Sample code please refer to How to use this driver

hal_eint_status_t hal_eint_unmask

(

hal_eint_number_t

eint_number

)

This function unmasks the dedicated EINT source.

Parameters

[in]

eint_number

is the EINT number, the value is HAL_EINT_0~HAL_EINT_MAX-1, please refer to hal_eint_number_t.

Returns

To indicate whether this function call is successful. If the return value is HAL_EINT_STATUS_OK, the operation completed successfully; If the return value is HAL_EINT_STATUS_INVALID_PARAMETER, a wrong parameter is given, the parameter must be verified.

See also

hal_eint_mask()