gas.h

Go to the documentation of this file.

/*
 * Microsemi Switchtec(tm) PCIe Management Library
 * Copyright (c) 2017, Microsemi Corporation
 *
 * 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 LIBSWITCHTEC_GAS_H
#define LIBSWITCHTEC_GAS_H
 
#include <switchtec/switchtec.h>
 
#ifdef SWITCHTEC_LIB_CORE
#error "You should not be using GAS access functions in the core library."
#endif
 
#ifdef SWITCHTEC_LIB_LINUX
#error "GAS Access functions should not be used on the Linux platform " \
    "as they require full root access."
#endif
 
#include <stdint.h>
 
void memcpy_to_gas(struct switchtec_dev *dev, void __gas *dest,
           const void *src, size_t n);
__attribute__((warn_unused_result))
int memcpy_from_gas(struct switchtec_dev *dev, void *dest,
            const void __gas *src, size_t n);
 
ssize_t write_from_gas(struct switchtec_dev *dev, int fd,
               const void __gas *src, size_t n);
 
__attribute__((warn_unused_result))
int gas_read8(struct switchtec_dev *dev, uint8_t __gas *addr, uint8_t *val);
__attribute__((warn_unused_result))
int gas_read16(struct switchtec_dev *dev, uint16_t __gas *addr, uint16_t *val);
__attribute__((warn_unused_result))
int gas_read32(struct switchtec_dev *dev, uint32_t __gas *addr, uint32_t *val);
__attribute__((warn_unused_result))
int gas_read64(struct switchtec_dev *dev, uint64_t __gas *addr, uint64_t *val);
 
void gas_write8(struct switchtec_dev *dev, uint8_t val, uint8_t __gas *addr);
void gas_write16(struct switchtec_dev *dev, uint16_t val,
         uint16_t __gas *addr);
void gas_write32(struct switchtec_dev *dev, uint32_t val,
         uint32_t __gas *addr);
void gas_write64(struct switchtec_dev *dev, uint64_t val,
         uint64_t __gas *addr);
 
#endif