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:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

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

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.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of Analog Devices, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES, INC. “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

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

Here is the caller graph for this function:

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

Here is the caller graph for this function:

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

Here is the caller graph for this function:

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

Here is the caller graph for this function:

interface_toggle_led()

int interface_toggle_led

(

struct no_os_gpio_desc *

gpio_led_desc

)

Toggle LED.

Toggle LED

Parameters

gpio_led_desc

- LED descriptor

Returns

0 in case of success, error code otherwise

Toggle LED.

Parameters

gpio_led_desc

- led descriptor

Returns

0 in case of success, negative error code otherwise.