drv_port.h

Go to the documentation of this file.

/****************************************************************************
**
** Copyright (C) 2024 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** This file is part of the mikroSDK package
**
** Commercial License Usage
**
** Licensees holding valid commercial NECTO compilers AI licenses may use this
** file in accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The MikroElektronika Company.
** For licensing terms and conditions see
** https://www.mikroe.com/legal/software-license-agreement.
** For further information use the contact form at
** https://www.mikroe.com/contact.
**
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used for
** non-commercial projects under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** OF MERCHANTABILITY, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
** TO THE WARRANTIES FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
** OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
**
****************************************************************************/
#ifndef _DRV_PORT_H_
#define _DRV_PORT_H_
 
#ifdef __cplusplus
extern "C"{
#endif
 
#include "drv_name.h"
#include "hal_gpio.h"
 
typedef enum
{
    PORT_SUCCESS = 0, 
    PORT_ERROR = (-1) 
} port_err_t;
 
typedef enum
{
    PIN_DIRECTION_DIGITAL_INPUT = 0,  
    PIN_DIRECTION_DIGITAL_OUTPUT = 1  
} pin_direction_t;
 
typedef struct
{
    hal_gpio_port_t port; 
    port_name_t name;     
} port_t;
 
err_t port_init( port_t *port, port_name_t name, port_size_t mask,
                 pin_direction_t direction
               );
 
#if defined(FLATTEN_ME) && (FLATTEN_ME_LEVEL >= FLATTEN_ME_LEVEL_HIGH)
#define port_write(_handle,_value) hal_gpio_write_port_output( (hal_gpio_port_t *)_handle, _value )
#else
err_t port_write( port_t *port, port_size_t value );
#endif
 
#if defined(FLATTEN_ME) && (FLATTEN_ME_LEVEL >= FLATTEN_ME_LEVEL_HIGH)
#define port_read_input(_handle) hal_gpio_read_port_input( (hal_gpio_port_t *)_handle )
#else
port_size_t port_read_input( port_t *port );
#endif
 
#if defined(FLATTEN_ME) && (FLATTEN_ME_LEVEL >= FLATTEN_ME_LEVEL_HIGH)
#define port_read_output(_handle) hal_gpio_read_port_output( (hal_gpio_port_t *)_handle )
#else
port_size_t port_read_output( port_t *port );
#endif
 
#define port_read port_read_output
 
 // portgroup
 // drvgroup
 // pergroup
 
#ifdef __cplusplus
}
#endif
 
#endif // _DRV_PORT_H_
// ------------------------------------------------------------------------- END