gr55xx_hal_msio.h File Reference

Header file containing functions prototypes of MSIO HAL library. More...

#include "gr55xx_ll_msio.h"
#include "gr55xx_hal_def.h"
#include "gr55xx_hal_msio_ex.h"
+ Include dependency graph for gr55xx_hal_msio.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  _msio_init
 MSIO init structure definition. More...
 

Macros

#define MSIO_PIN_0   ((uint16_t)0x0001U)
 Pin 0 selected
More...
 
#define MSIO_PIN_1   ((uint16_t)0x0002U)
 Pin 1 selected
More...
 
#define MSIO_PIN_2   ((uint16_t)0x0004U)
 Pin 2 selected
More...
 
#define MSIO_PIN_3   ((uint16_t)0x0008U)
 Pin 3 selected
More...
 
#define MSIO_PIN_4   ((uint16_t)0x0010U)
 Pin 4 selected
More...
 
#define MSIO_PIN_ALL   ((uint16_t)0x001FU)
 All pins selected. More...
 
#define MSIO_PIN_MASK   (0x0000001FU)
 PIN mask for assert test. More...
 
#define MSIO_DIRECTION_NONE   LL_MSIO_DIRECTION_NONE
 Disable input & output. More...
 
#define MSIO_DIRECTION_INPUT   LL_MSIO_DIRECTION_INPUT
 Only Input
More...
 
#define MSIO_DIRECTION_OUTPUT   LL_MSIO_DIRECTION_OUTPUT
 Only Output
More...
 
#define MSIO_DIRECTION_INOUT   LL_MSIO_DIRECTION_INOUT
 Input & Output
More...
 
#define MSIO_MODE_ANALOG   LL_MSIO_MODE_ANALOG
 Analog IO. More...
 
#define MSIO_MODE_DIGITAL   LL_MSIO_MODE_DIGITAL
 Digital IO. More...
 
#define MSIO_NOPULL   LL_MSIO_PULL_NO
 No Pull-up or Pull-down activation
More...
 
#define MSIO_PULLUP   LL_MSIO_PULL_UP
 Pull-up activation
More...
 
#define MSIO_PULLDOWN   LL_MSIO_PULL_DOWN
 Pull-down activation
More...
 
#define MSIO_DEFAULT_CONFIG
 MSIO_default_config initStruct default configuartion. More...
 
#define IS_MSIO_PIN_ACTION(__ACTION__)   (((__ACTION__) == MSIO_PIN_RESET) || ((__ACTION__) == MSIO_PIN_SET))
 Check if MSIO pin action is valid. More...
 
#define IS_MSIO_PIN(__PIN__)
 Check if MSIO pins are valid. More...
 
#define IS_MSIO_DIRECTION(__DIR__)
 Check if MSIO direction is valid. More...
 
#define IS_MSIO_MODE(__MODE__)
 Check if MSIO mode is valid. More...
 
#define IS_MSIO_PULL(__PULL__)
 Check if MSIO pull type is valid. More...
 

Typedefs

typedef struct _msio_init msio_init_t
 MSIO init structure definition. More...
 

Enumerations

enum  msio_pin_state_t { MSIO_PIN_RESET = 0U, MSIO_PIN_SET }
 MSIO Bit SET and Bit RESET enumerations. More...
 

Functions

void hal_msio_init (msio_pad_t MSIOx, msio_init_t *p_msio_init)
 Initialize the MSIOx peripheral according to the specified parameters in the msio_init_t. More...
 
void hal_msio_deinit (msio_pad_t MSIOx, uint32_t msio_pin)
 De-initialize the MSIOx peripheral registers to their default reset values. More...
 
msio_pin_state_t hal_msio_read_pin (msio_pad_t MSIOx, uint16_t msio_pin)
 Read the specified input port pin. More...
 
void hal_msio_write_pin (msio_pad_t MSIOx, uint16_t msio_pin, msio_pin_state_t pin_state)
 Set or clear the selected data port bit. More...
 
void hal_msio_toggle_pin (msio_pad_t MSIOx, uint16_t msio_pin)
 Toggle the specified MSIO pin. More...
 

Detailed Description

Header file containing functions prototypes of MSIO HAL library.

Author
BLE Driver Team
Attention
Copyright (c) 2019 GOODIX

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 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. Neither the name of GOODIX 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 THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT HOLDERS AND CONTRIBUTORS 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.

Definition in file gr55xx_hal_msio.h.