Blame opae-libs/plugins/xfpga/umsg.c

Packit 534379
// Copyright(c) 2017-2020, Intel Corporation
Packit 534379
//
Packit 534379
// Redistribution  and  use  in source  and  binary  forms,  with  or  without
Packit 534379
// modification, are permitted provided that the following conditions are met:
Packit 534379
//
Packit 534379
// * Redistributions of  source code  must retain the  above copyright notice,
Packit 534379
//   this list of conditions and the following disclaimer.
Packit 534379
// * Redistributions in binary form must reproduce the above copyright notice,
Packit 534379
//   this list of conditions and the following disclaimer in the documentation
Packit 534379
//   and/or other materials provided with the distribution.
Packit 534379
// * Neither the name  of Intel Corporation  nor the names of its contributors
Packit 534379
//   may be used to  endorse or promote  products derived  from this  software
Packit 534379
//   without specific prior written permission.
Packit 534379
//
Packit 534379
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Packit 534379
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,  BUT NOT LIMITED TO,  THE
Packit 534379
// IMPLIED WARRANTIES OF  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
Packit 534379
// ARE DISCLAIMED.  IN NO EVENT  SHALL THE COPYRIGHT OWNER  OR CONTRIBUTORS BE
Packit 534379
// LIABLE  FOR  ANY  DIRECT,  INDIRECT,  INCIDENTAL,  SPECIAL,  EXEMPLARY,  OR
Packit 534379
// CONSEQUENTIAL  DAMAGES  (INCLUDING,  BUT  NOT LIMITED  TO,  PROCUREMENT  OF
Packit 534379
// SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE,  DATA, OR PROFITS;  OR BUSINESS
Packit 534379
// INTERRUPTION)  HOWEVER CAUSED  AND ON ANY THEORY  OF LIABILITY,  WHETHER IN
Packit 534379
// CONTRACT,  STRICT LIABILITY,  OR TORT  (INCLUDING NEGLIGENCE  OR OTHERWISE)
Packit 534379
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,  EVEN IF ADVISED OF THE
Packit 534379
// POSSIBILITY OF SUCH DAMAGE.
Packit 534379
Packit 534379
#ifdef HAVE_CONFIG_H
Packit 534379
#include <config.h>
Packit 534379
#endif // HAVE_CONFIG_H
Packit 534379
Packit 534379
#include "opae/access.h"
Packit 534379
#include "opae/utils.h"
Packit 534379
#include "opae/umsg.h"
Packit 534379
#include "common_int.h"
Packit 534379
#include "opae_drv.h"
Packit 534379
#include "intel-fpga.h"
Packit 534379
Packit 534379
#include <sys/types.h>
Packit 534379
#include <sys/stat.h>
Packit 534379
#include <sys/ioctl.h>
Packit 534379
#include <sys/mman.h>
Packit 534379
#include <stdint.h>
Packit 534379
Packit 534379
Packit 534379
// Get number of Umsgs
Packit 534379
fpga_result __XFPGA_API__
Packit 534379
xfpga_fpgaGetNumUmsg(fpga_handle handle, uint64_t *value)
Packit 534379
{
Packit 534379
	struct _fpga_handle  *_handle = (struct _fpga_handle *)handle;
Packit 534379
	fpga_result result            = FPGA_OK;
Packit 534379
	int err                       = 0;
Packit 534379
	opae_port_info port_info      = { 0 };
Packit 534379
Packit 534379
	ASSERT_NOT_NULL(value);
Packit 534379
	result = handle_check_and_lock(_handle);
Packit 534379
	if (result)
Packit 534379
		return result;
Packit 534379
Packit 534379
	if (_handle->fddev < 0) {
Packit 534379
		OPAE_ERR("Invalid handle file descriptor");
Packit 534379
		result = FPGA_INVALID_PARAM;
Packit 534379
		goto out_unlock;
Packit 534379
	}
Packit 534379
Packit 534379
Packit 534379
	result = opae_get_port_info(_handle->fddev, &port_info);
Packit 534379
	if (!result) {
Packit 534379
		*value = port_info.num_umsgs;
Packit 534379
	}
Packit 534379
Packit 534379
out_unlock:
Packit 534379
	err = pthread_mutex_unlock(&_handle->lock);
Packit 534379
	if (err)
Packit 534379
		OPAE_ERR("pthread_mutex_unlock() failed: %s", strerror(err));
Packit 534379
	return result;
Packit 534379
}
Packit 534379
Packit 534379
// Set Umsg Attributes
Packit 534379
fpga_result __XFPGA_API__
Packit 534379
xfpga_fpgaSetUmsgAttributes(fpga_handle handle, uint64_t value)
Packit 534379
{
Packit 534379
	struct _fpga_handle  *_handle         = (struct _fpga_handle *)handle;
Packit 534379
	fpga_result result                    = FPGA_OK;
Packit 534379
	int err                               = 0;
Packit 534379
Packit 534379
	result = handle_check_and_lock(_handle);
Packit 534379
	if (result)
Packit 534379
		return result;
Packit 534379
Packit 534379
	if (_handle->fddev < 0) {
Packit 534379
		OPAE_ERR("Invalid handle file descriptor");
Packit 534379
		result = FPGA_INVALID_PARAM;
Packit 534379
		goto out_unlock;
Packit 534379
	}
Packit 534379
Packit 534379
Packit 534379
	result = opae_port_umsg_cfg(_handle->fddev, 0, value);
Packit 534379
Packit 534379
out_unlock:
Packit 534379
	err = pthread_mutex_unlock(&_handle->lock);
Packit 534379
	if (err)
Packit 534379
		OPAE_ERR("pthread_mutex_unlock() failed: %s", strerror(err));
Packit 534379
	return result;
Packit 534379
}
Packit 534379
Packit 534379
// Gets Umsg address
Packit 534379
fpga_result __XFPGA_API__
Packit 534379
xfpga_fpgaGetUmsgPtr(fpga_handle handle, uint64_t **umsg_ptr)
Packit 534379
{
Packit 534379
	struct _fpga_handle  *_handle            = (struct _fpga_handle *)handle;
Packit 534379
	opae_port_info port_info                 = { 0 };
Packit 534379
Packit 534379
	fpga_result result                       = FPGA_OK;
Packit 534379
	uint64_t umsg_count                      = 0;
Packit 534379
	uint64_t umsg_size                       = 0;
Packit 534379
	int pagesize                             = 0;
Packit 534379
	void *umsg_virt                          = NULL;
Packit 534379
	int err                                  = 0;
Packit 534379
	uint64_t io_addr = 0;
Packit 534379
Packit 534379
	ASSERT_NOT_NULL(umsg_ptr);
Packit 534379
	result = handle_check_and_lock(_handle);
Packit 534379
	if (result)
Packit 534379
		return result;
Packit 534379
Packit 534379
	if (_handle->fddev < 0) {
Packit 534379
		OPAE_ERR("Invalid handle file descriptor");
Packit 534379
		result = FPGA_INVALID_PARAM;
Packit 534379
		goto out_unlock;
Packit 534379
	}
Packit 534379
Packit 534379
	if (_handle->umsg_iova != NULL) {
Packit 534379
		*umsg_ptr = _handle->umsg_virt;
Packit 534379
		goto out_unlock;
Packit 534379
	}
Packit 534379
Packit 534379
	// Page size
Packit 534379
	pagesize = sysconf(_SC_PAGESIZE);
Packit 534379
Packit 534379
	// get umsg count
Packit 534379
	result = opae_get_port_info(_handle->fddev, &port_info);
Packit 534379
	if (result != FPGA_OK) {
Packit 534379
		OPAE_MSG("Failed to get UMSG count");
Packit 534379
		goto out_unlock;
Packit 534379
	}
Packit 534379
	umsg_count = port_info.num_umsgs;
Packit 534379
	umsg_size = (uint64_t)umsg_count  * pagesize;
Packit 534379
	umsg_virt = alloc_buffer(umsg_size);
Packit 534379
	if (umsg_virt == NULL) {
Packit 534379
		OPAE_ERR("Failed to allocate memory");
Packit 534379
		result = FPGA_NO_MEMORY;
Packit 534379
		goto out_unlock;
Packit 534379
	}
Packit 534379
Packit 534379
	// Map Umsg Buffer
Packit 534379
	result = opae_port_map(_handle->fddev, umsg_virt, umsg_size, 0, &io_addr);
Packit 534379
	if (result != 0) {
Packit 534379
		OPAE_ERR("Failed to map UMSG buffer");
Packit 534379
		goto umsg_exit;
Packit 534379
	}
Packit 534379
Packit 534379
	// Set Umsg Address
Packit 534379
	result = opae_port_umsg_set_base_addr(_handle->fddev, 0, io_addr);
Packit 534379
	if (result != 0) {
Packit 534379
		OPAE_ERR("Failed to set UMSG base address");
Packit 534379
		goto umsg_map_exit;
Packit 534379
	}
Packit 534379
Packit 534379
	result = opae_port_umsg_enable(_handle->fddev);
Packit 534379
	if (result != 0) {
Packit 534379
		OPAE_ERR("Failed to enable UMSG");
Packit 534379
		goto umsg_map_exit;
Packit 534379
	}
Packit 534379
Packit 534379
	*umsg_ptr = (uint64_t *) umsg_virt;
Packit 534379
	_handle->umsg_iova = (uint64_t *)io_addr;
Packit 534379
	_handle->umsg_virt = umsg_virt;
Packit 534379
	_handle->umsg_size = umsg_size;
Packit 534379
Packit 534379
out_unlock:
Packit 534379
	err = pthread_mutex_unlock(&_handle->lock);
Packit 534379
	if (err)
Packit 534379
		OPAE_ERR("pthread_mutex_unlock() failed: %s", strerror(err));
Packit 534379
	return result;
Packit 534379
Packit 534379
umsg_map_exit:
Packit 534379
	result = opae_port_unmap(_handle->fddev, io_addr);
Packit 534379
	if (result) {
Packit 534379
		OPAE_MSG("Failed to unmap UMSG buffer");
Packit 534379
	}
Packit 534379
Packit 534379
umsg_exit:
Packit 534379
	if (umsg_virt != NULL)
Packit 534379
		free_buffer(umsg_virt, umsg_size);
Packit 534379
Packit 534379
	err = pthread_mutex_unlock(&_handle->lock);
Packit 534379
	if (err)
Packit 534379
		OPAE_ERR("pthread_mutex_unlock() failed: %s", strerror(err));
Packit 534379
	return result;
Packit 534379
}
Packit 534379
Packit 534379
fpga_result free_umsg_buffer(fpga_handle handle)
Packit 534379
{
Packit 534379
	fpga_result result                = FPGA_OK;
Packit 534379
	struct _fpga_handle  *_handle     = (struct _fpga_handle *)handle;
Packit 534379
	int err                           = 0;
Packit 534379
Packit 534379
Packit 534379
	result = handle_check_and_lock(_handle);
Packit 534379
	if (result)
Packit 534379
		return result;
Packit 534379
Packit 534379
	if (_handle->umsg_virt != NULL) {
Packit 534379
		if (opae_port_umsg_disable(_handle->fddev)) {
Packit 534379
			OPAE_ERR("Failed to disable UMSG");
Packit 534379
		}
Packit 534379
Packit 534379
		if (opae_port_umsg_set_base_addr(_handle->fddev, 0, 0)) {
Packit 534379
			OPAE_ERR("Failed to zero UMSG address");
Packit 534379
		}
Packit 534379
Packit 534379
		if (opae_port_unmap(_handle->fddev, (uint64_t)_handle->umsg_iova)) {
Packit 534379
			OPAE_ERR("Failed to unmap UMSG Buffer");
Packit 534379
		}
Packit 534379
Packit 534379
		free_buffer(_handle->umsg_virt, _handle->umsg_size);
Packit 534379
Packit 534379
		_handle->umsg_virt = NULL;
Packit 534379
		_handle->umsg_size = 0;
Packit 534379
		_handle->umsg_iova = NULL;
Packit 534379
	}
Packit 534379
Packit 534379
	err = pthread_mutex_unlock(&_handle->lock);
Packit 534379
	if (err)
Packit 534379
		OPAE_ERR("pthread_mutex_unlock() failed: %s", strerror(err));
Packit 534379
	return result;
Packit 534379
}
Packit 534379
Packit 534379
// Trigger umsg
Packit 534379
fpga_result __XFPGA_API__
Packit 534379
xfpga_fpgaTriggerUmsg(fpga_handle handle, uint64_t value)
Packit 534379
{
Packit 534379
	struct _fpga_handle  *_handle = (struct _fpga_handle *)handle;
Packit 534379
	fpga_result result            = FPGA_OK;
Packit 534379
	uint64_t *umsg_ptr            = NULL;
Packit 534379
	int err                       = 0;
Packit 534379
Packit 534379
	result = handle_check_and_lock(_handle);
Packit 534379
	if (result)
Packit 534379
		return result;
Packit 534379
Packit 534379
	if (_handle->fddev < 0) {
Packit 534379
		OPAE_ERR("Invalid handle file descriptor");
Packit 534379
		result = FPGA_INVALID_PARAM;
Packit 534379
		goto out_unlock;
Packit 534379
	}
Packit 534379
Packit 534379
	result = xfpga_fpgaGetUmsgPtr(handle, &umsg_ptr);
Packit 534379
	if (result != FPGA_OK) {
Packit 534379
		OPAE_ERR("Failed to get UMsg buffer");
Packit 534379
		goto out_unlock;
Packit 534379
	}
Packit 534379
Packit 534379
	// Assign Value to UMsg
Packit 534379
	*((volatile uint64_t *) (umsg_ptr)) = value;
Packit 534379
Packit 534379
out_unlock:
Packit 534379
	err = pthread_mutex_unlock(&_handle->lock);
Packit 534379
	if (err)
Packit 534379
		OPAE_ERR("pthread_mutex_unlock() failed: %s", strerror(err));
Packit 534379
	return result;
Packit 534379
}