Enum

Overview

Enumerations
enum	hal_gpio_direction_t {   HAL_GPIO_DIRECTION_INPUT = 0,   HAL_GPIO_DIRECTION_OUTPUT = 1 }
	This enum defines the GPIO direction. More...
enum	hal_gpio_data_t {   HAL_GPIO_DATA_LOW = 0,   HAL_GPIO_DATA_HIGH = 1 }
	This enum defines the data type of GPIO. More...
enum	hal_gpio_status_t {   HAL_GPIO_STATUS_ERROR = -3,   HAL_GPIO_STATUS_ERROR_PIN = -2,   HAL_GPIO_STATUS_INVALID_PARAMETER = -1,   HAL_GPIO_STATUS_OK = 0 }
	This enum defines the return type of GPIO API. More...
enum	hal_pinmux_status_t {   HAL_PINMUX_STATUS_ERROR = -3,   HAL_PINMUX_STATUS_ERROR_PORT = -2,   HAL_PINMUX_STATUS_INVALID_FUNCTION = -1,   HAL_PINMUX_STATUS_OK = 0 }
	This enum defines the return type of pinmux API. More...
enum	hal_gpio_pin_t {   HAL_GPIO_0 = 0,   HAL_GPIO_1 = 1,   HAL_GPIO_2 = 2,   HAL_GPIO_3 = 3,   HAL_GPIO_4 = 4,   HAL_GPIO_5 = 5,   HAL_GPIO_6 = 6,   HAL_GPIO_7 = 7,   HAL_GPIO_8 = 8,   HAL_GPIO_9 = 9,   HAL_GPIO_10 = 10,   HAL_GPIO_11 = 11,   HAL_GPIO_12 = 12,   HAL_GPIO_13 = 13,   HAL_GPIO_14 = 14,   HAL_GPIO_15 = 15,   HAL_GPIO_16 = 16,   HAL_GPIO_17 = 17,   HAL_GPIO_18 = 18,   HAL_GPIO_19 = 19,   HAL_GPIO_20 = 20,   HAL_GPIO_21 = 21,   HAL_GPIO_22 = 22,   HAL_GPIO_23 = 23,   HAL_GPIO_24 = 24,   HAL_GPIO_25 = 25,   HAL_GPIO_26 = 26,   HAL_GPIO_27 = 27,   HAL_GPIO_28 = 28,   HAL_GPIO_29 = 29,   HAL_GPIO_30 = 30,   HAL_GPIO_31 = 31,   HAL_GPIO_32 = 32,   HAL_GPIO_33 = 33,   HAL_GPIO_34 = 34,   HAL_GPIO_35 = 35,   HAL_GPIO_36 = 36,   HAL_GPIO_37 = 37,   HAL_GPIO_38 = 38,   HAL_GPIO_39 = 39,   HAL_GPIO_40 = 40,   HAL_GPIO_41 = 41,   HAL_GPIO_42 = 42,   HAL_GPIO_43 = 43,   HAL_GPIO_44 = 44,   HAL_GPIO_45 = 45,   HAL_GPIO_46 = 46,   HAL_GPIO_47 = 47,   HAL_GPIO_48 = 48,   HAL_GPIO_MAX }
	This enum defines the GPIO port. More...
enum	hal_gpio_clock_t {   HAL_GPIO_CLOCK_0 = 0,   HAL_GPIO_CLOCK_1 = 1,   HAL_GPIO_CLOCK_2 = 2,   HAL_GPIO_CLOCK_3 = 3,   HAL_GPIO_CLOCK_4 = 4,   HAL_GPIO_CLOCK_5 = 5,   HAL_GPIO_CLOCK_MAX }
	This enum defines output clock number of GPIO. More...
enum	hal_gpio_clock_mode_t {   HAL_GPIO_CLOCK_MODE_26M = 1,   HAL_GPIO_CLOCK_MODE_32K = 4,   HAL_GPIO_CLOCK_MODE_MAX }
	This enum defines output clock mode of GPIO. More...

Enumeration Type Documentation

enum hal_gpio_clock_mode_t

This enum defines output clock mode of GPIO.

Enumerator
HAL_GPIO_CLOCK_MODE_26M	define GPIO output clock mode as 26MHz
HAL_GPIO_CLOCK_MODE_32K	define GPIO output clock mode as 32KHz
HAL_GPIO_CLOCK_MODE_MAX	define GPIO output clock mode of max number(invalid)

enum hal_gpio_clock_t

This enum defines output clock number of GPIO.

Enumerator
HAL_GPIO_CLOCK_0	define GPIO output clock 0
HAL_GPIO_CLOCK_1	define GPIO output clock 1
HAL_GPIO_CLOCK_2	define GPIO output clock 2
HAL_GPIO_CLOCK_3	define GPIO output clock 3
HAL_GPIO_CLOCK_4	define GPIO output clock 4
HAL_GPIO_CLOCK_5	define GPIO output clock 5
HAL_GPIO_CLOCK_MAX	define GPIO output clock max number(invalid)

enum hal_gpio_data_t

This enum defines the data type of GPIO.

Enumerator
HAL_GPIO_DATA_LOW	GPIO data low.
HAL_GPIO_DATA_HIGH	GPIO data high.

enum hal_gpio_direction_t

This enum defines the GPIO direction.

Enumerator
HAL_GPIO_DIRECTION_INPUT	GPIO input direction.
HAL_GPIO_DIRECTION_OUTPUT	GPIO output direction.

enum hal_gpio_pin_t

This enum defines the GPIO port.

The platform supports a total of 49 GPIO pins with various functionality.

Enumerator
HAL_GPIO_0	GPIO pin0.
HAL_GPIO_1	GPIO pin1.
HAL_GPIO_2	GPIO pin2.
HAL_GPIO_3	GPIO pin3.
HAL_GPIO_4	GPIO pin4.
HAL_GPIO_5	GPIO pin5.
HAL_GPIO_6	GPIO pin6.
HAL_GPIO_7	GPIO pin7.
HAL_GPIO_8	GPIO pin8.
HAL_GPIO_9	GPIO pin9.
HAL_GPIO_10	GPIO pin10.
HAL_GPIO_11	GPIO pin11.
HAL_GPIO_12	GPIO pin12.
HAL_GPIO_13	GPIO pin13.
HAL_GPIO_14	GPIO pin14.
HAL_GPIO_15	GPIO pin15.
HAL_GPIO_16	GPIO pin16.
HAL_GPIO_17	GPIO pin17.
HAL_GPIO_18	GPIO pin18.
HAL_GPIO_19	GPIO pin19.
HAL_GPIO_20	GPIO pin20.
HAL_GPIO_21	GPIO pin21.
HAL_GPIO_22	GPIO pin22.
HAL_GPIO_23	GPIO pin23.
HAL_GPIO_24	GPIO pin24.
HAL_GPIO_25	GPIO pin25.
HAL_GPIO_26	GPIO pin26.
HAL_GPIO_27	GPIO pin27.
HAL_GPIO_28	GPIO pin28.
HAL_GPIO_29	GPIO pin29.
HAL_GPIO_30	GPIO pin30.
HAL_GPIO_31	GPIO pin31.
HAL_GPIO_32	GPIO pin32.
HAL_GPIO_33	GPIO pin33.
HAL_GPIO_34	GPIO pin34.
HAL_GPIO_35	GPIO pin35.
HAL_GPIO_36	GPIO pin36.
HAL_GPIO_37	GPIO pin37.
HAL_GPIO_38	GPIO pin38.
HAL_GPIO_39	GPIO pin39.
HAL_GPIO_40	GPIO pin40.
HAL_GPIO_41	GPIO pin41.
HAL_GPIO_42	GPIO pin42.
HAL_GPIO_43	GPIO pin43.
HAL_GPIO_44	GPIO pin44.
HAL_GPIO_45	GPIO pin45.
HAL_GPIO_46	GPIO pin46.
HAL_GPIO_47	GPIO pin47.
HAL_GPIO_48	GPIO pin48.
HAL_GPIO_MAX	The total number of GPIO pins (invalid GPIO pin number).

enum hal_gpio_status_t

This enum defines the return type of GPIO API.

Enumerator
HAL_GPIO_STATUS_ERROR	The GPIO function failed to execute.
HAL_GPIO_STATUS_ERROR_PIN	Invalid input pin number.
HAL_GPIO_STATUS_INVALID_PARAMETER	Invalid input parameter.
HAL_GPIO_STATUS_OK	The GPIO function executed successfully.

enum hal_pinmux_status_t

This enum defines the return type of pinmux API.

Enumerator
HAL_PINMUX_STATUS_ERROR	The pinmux function failed to execute.
HAL_PINMUX_STATUS_ERROR_PORT	Invalid input pin port.
HAL_PINMUX_STATUS_INVALID_FUNCTION	Invalid input function.
HAL_PINMUX_STATUS_OK	The pinmux function executed successfully.