armport.h

Go to the documentation of this file.

// ---------------------------------------------------------------------
// Created date: 17.11.2015
// ---------------------------------------------------------------------

/***********************************************************************

 Copyright (c) 2016 ATIM
 
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
 
 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, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 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 ARMPORT_H
#define ARMPORT_H

// ---------------------------------------------------------------------
// Include
// ---------------------------------------------------------------------

#include <stdint.h>
#include <stddef.h>
#include <stdbool.h>
#include "armconfig.h"

#ifdef __cplusplus
extern "C"
{
#endif

#ifndef __DOXYGEN__
//Memories functions at to define by port
extern void bzero(void *s, size_t n);
extern void *memmem(const void *haystack, size_t haystacklen, const void *needle, size_t needlelen);
#endif
 
// ---------------------------------------------------------------------
// Enum
// ---------------------------------------------------------------------

typedef enum
{
    ARMPORT_BAUDRATE_NONE   = 0,        
    ARMPORT_BAUDRATE_1200   = 1200,     
    ARMPORT_BAUDRATE_2400   = 2400,     
    ARMPORT_BAUDRATE_4800   = 4800,     
    ARMPORT_BAUDRATE_9600   = 9600,     
    ARMPORT_BAUDRATE_19200  = 19200,    
    ARMPORT_BAUDRATE_38400  = 38400,    
    ARMPORT_BAUDRATE_57600  = 57600,    
    ARMPORT_BAUDRATE_115200 = 115200,   
    ARMPORT_BAUDRATE_230400 = 230400    
}armPortBaudrate_t;

typedef enum
{
    ARMPORT_DATA_7BITS      = 7,    
    ARMPORT_DATA_8BITS      = 8     
}armPortDatabits_t;

typedef enum
{
    ARMPORT_PARITY_NO,      
    ARMPORT_PARITY_ODD,     
    ARMPORT_PARITY_EVEN     
}armPortParity_t;

typedef enum
{
    ARMPORT_STOPBIT_1       = 1,    
    ARMPORT_STOPBIT_2       = 2     
}armPortStopbit_t;

// ---------------------------------------------------------------------
// struct
// ---------------------------------------------------------------------

#if defined ARMPORT_WITH_nSLEEP || defined ARMPORT_WITH_nBOOT || defined ARMPORT_WITH_nRESET || __DOXYGEN__

typedef enum armPortPin_e
{
    #if defined ARMPORT_WITH_nSLEEP || __DOXYGEN__
    ARMPORT_PIN_nSLEEP,     
    #endif
    #if defined ARMPORT_WITH_nBOOT || __DOXYGEN__
    ARMPORT_PIN_nBOOT,      
    #endif
    #if defined ARMPORT_WITH_nRESET || __DOXYGEN__
    ARMPORT_PIN_nRESET,     
    #endif
}armPortPin_t;
#endif

// ---------------------------------------------------------------------
// Prototypes functions
// ---------------------------------------------------------------------

int armPortOpen(void** port);

int armPortConfig(void* port,   armPortBaudrate_t baudrate,
                                armPortDatabits_t databits,
                                armPortParity_t parity,
                                armPortStopbit_t stopbit);
int armPortClose(void* port);

int armPortWrite(void* port, const void* buf, size_t nbyte);

int armPortRead(void* port, void* buf, size_t nbyte, unsigned int timeout);

void armPortDelay(unsigned int ms);

#if defined ARMPORT_WITH_nSLEEP || defined ARMPORT_WITH_nBOOT || defined ARMPORT_WITH_nRESET || __DOXYGEN__

void armPortGpioSet(void* port, armPortPin_t pin, bool val);
#endif


#ifdef __cplusplus
}
#endif

#endif //ARMPORT_H