interface.h File Reference

User interface interface file. More...

#include "state_machine.h"
#include "parameters.h"
#include "no_os_gpio.h"

Include dependency graph for interface.h:

Functions
int	interface_init (struct no_os_gpio_desc **gpio_led_desc)
	Interface initialization routines.
int	interface_led_on (struct no_os_gpio_desc *gpio_led_desc)
	Turn LED on.
int	interface_led_off (struct no_os_gpio_desc *gpio_led_desc)
	Turn LED off.
int	interface_toggle_led (struct no_os_gpio_desc *gpio_led_desc)
	Toggle LED.
int	interface_disp (struct stout *stout)
	Display error code.
int	interface_blink_time (struct stout *stout)
	Get interface blink time (multimple of 20ms)

Detailed Description

User interface interface file.

Author

GMois (georg.nosp@m.e.mo.nosp@m.is@an.nosp@m.alog.nosp@m..com), REtz (radu..nosp@m.etz@.nosp@m.analo.nosp@m.g.co.nosp@m.m)

Copyright (c) 2023 Analog Devices, Inc.

SPDX-License-Identifier: BSD-3-Clause

Function Documentation

interface_blink_time()

int interface_blink_time

(

struct stout *

stout

)

Get interface blink time (multimple of 20ms)

Get interface blink time (multimple of 20ms)

Parameters

stout

- state machine descriptor

Returns

0 in case of success, error code otherwise

interface_disp()

int interface_disp

(

struct stout *

stout

)

Display error code.

Display error code

Parameters

stout

- state machine descriptor

Returns

0 in case of success, error code otherwise

interface_init()

int interface_init

(

struct no_os_gpio_desc **

gpio_led_desc

)

Interface initialization routines.

Interface initialization routines

Parameters

gpio_led_desc

- poionter to first LED descriptor

Returns

0 in case of success, error code otherwise

interface_led_off()

int interface_led_off

(

struct no_os_gpio_desc *

gpio_led_desc

)

Turn LED off.

Turn LED off

Parameters

gpio_led_desc

- LED descriptor

Returns

0 in case of success, error code otherwise

interface_led_on()

int interface_led_on

(

struct no_os_gpio_desc *

gpio_led_desc

)

Turn LED on.

Turn LED on

Parameters

gpio_led_desc

- LED descriptor

Returns

0 in case of success, error code otherwise

interface_toggle_led()

int interface_toggle_led

(

struct no_os_gpio_desc *

gpio_led_desc

)

Toggle LED.

Toggle LED

Toggle Led.

Parameters

gpio_led_desc

- LED descriptor

Returns

0 in case of success, error code otherwise

Parameters

gpio_led_desc

- led descriptor

Returns

0 in case of success, negative error code otherwise.

Toggle LED.

Parameters

gpio_led_desc

- led descriptor

Returns

0 in case of success, negative error code otherwise.