1215976Sjmallett/***********************license start*************** 2232812Sjmallett * Copyright (c) 2003-2010 Cavium Inc. (support@cavium.com). All rights 3215976Sjmallett * reserved. 4215976Sjmallett * 5215976Sjmallett * 6215976Sjmallett * Redistribution and use in source and binary forms, with or without 7215976Sjmallett * modification, are permitted provided that the following conditions are 8215976Sjmallett * met: 9215976Sjmallett * 10215976Sjmallett * * Redistributions of source code must retain the above copyright 11215976Sjmallett * notice, this list of conditions and the following disclaimer. 12215976Sjmallett * 13215976Sjmallett * * Redistributions in binary form must reproduce the above 14215976Sjmallett * copyright notice, this list of conditions and the following 15215976Sjmallett * disclaimer in the documentation and/or other materials provided 16215976Sjmallett * with the distribution. 17215976Sjmallett 18232812Sjmallett * * Neither the name of Cavium Inc. nor the names of 19215976Sjmallett * its contributors may be used to endorse or promote products 20215976Sjmallett * derived from this software without specific prior written 21215976Sjmallett * permission. 22215976Sjmallett 23215976Sjmallett * This Software, including technical data, may be subject to U.S. export control 24215976Sjmallett * laws, including the U.S. Export Administration Act and its associated 25215976Sjmallett * regulations, and may be subject to export or import regulations in other 26215976Sjmallett * countries. 27215976Sjmallett 28215976Sjmallett * TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS" 29232812Sjmallett * AND WITH ALL FAULTS AND CAVIUM INC. MAKES NO PROMISES, REPRESENTATIONS OR 30215976Sjmallett * WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT TO 31215976Sjmallett * THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY REPRESENTATION OR 32215976Sjmallett * DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT DEFECTS, AND CAVIUM 33215976Sjmallett * SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES OF TITLE, 34215976Sjmallett * MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR PURPOSE, LACK OF 35215976Sjmallett * VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET POSSESSION OR 36215976Sjmallett * CORRESPONDENCE TO DESCRIPTION. THE ENTIRE RISK ARISING OUT OF USE OR 37215976Sjmallett * PERFORMANCE OF THE SOFTWARE LIES WITH YOU. 38215976Sjmallett ***********************license end**************************************/ 39215976Sjmallett 40215976Sjmallett 41215976Sjmallett#ifndef __CVMX_SHMEM_H__ 42215976Sjmallett#define __CVMX_SHMEM_H__ 43215976Sjmallett 44215976Sjmallett/** 45215976Sjmallett * @file 46215976Sjmallett * 47215976Sjmallett * cvmx-shmem provides APIs for setting up shared memory between Linux 48215976Sjmallett * and simple executive applications. 49215976Sjmallett * 50215976Sjmallett * <hr>$Revision: 41586 $<hr> 51215976Sjmallett */ 52215976Sjmallett 53215976Sjmallett 54215976Sjmallett#ifdef __cplusplus 55215976Sjmallettextern "C" { 56215976Sjmallett#endif 57215976Sjmallett 58215976Sjmallett#include "cvmx-spinlock.h" 59215976Sjmallett 60215976Sjmallett#define CVMX_SHMEM_NUM_DSCPTR 8 61215976Sjmallett#define CVMX_SHMEM_DSCPTR_NAME "SMDR" 62215976Sjmallett 63215976Sjmallett#define CVMX_SHMEM_O_RDONLY 0x00 64215976Sjmallett#define CVMX_SHMEM_O_WRONLY 0x01 65215976Sjmallett#define CVMX_SHMEM_O_RDWR 0x02 66215976Sjmallett#define CVMX_SHMEM_O_CREAT 0x04 67215976Sjmallett 68215976Sjmallett#define CVMX_SHMEM_MAP_PROT_READ 0x01 69215976Sjmallett#define CVMX_SHMEM_MAP_PROT_WRITE 0x02 70215976Sjmallett#define CVMX_SHMEM_MAP_EXEC 0x04 71215976Sjmallett 72215976Sjmallett#define CVMX_SHMEM_OWNER_NONE 0xff 73215976Sjmallett 74215976Sjmallett#define CVMX_SHMEM_VADDR64_START 0x500000000ULL 75215976Sjmallett#define CVMX_SHMEM_VADDR64_END 0x600000000ULL 76215976Sjmallett 77215976Sjmallett#define CVMX_SHMEM_VADDR32_START 0x10000000 78215976Sjmallett#define CVMX_SHMEM_VADDR32_END 0x18000000 79215976Sjmallett 80215976Sjmallettstruct cvmx_shmem_dscptr { 81215976Sjmallett cvmx_spinlock_t lock; 82215976Sjmallett uint64_t owner: 8; 83215976Sjmallett uint64_t is_named_block: 1; 84215976Sjmallett uint64_t p_wronly: 1; 85215976Sjmallett uint64_t p_rdwr: 1; 86215976Sjmallett int32_t use_count; /* must use atomic operation to maintain count */ 87215976Sjmallett const char *name; 88215976Sjmallett void *vaddr; 89215976Sjmallett uint64_t paddr; 90215976Sjmallett uint32_t size; 91215976Sjmallett uint64_t alignment; 92215976Sjmallett}; 93215976Sjmallett 94215976Sjmallettstruct cvmx_shmem_smdr { 95215976Sjmallett cvmx_spinlock_t lock; 96215976Sjmallett struct cvmx_shmem_dscptr shmd[CVMX_SHMEM_NUM_DSCPTR]; 97215976Sjmallett void *break64; /* Keep track of unused 64 bit virtual address space */ 98215976Sjmallett}; 99215976Sjmallett 100215976Sjmallett 101215976Sjmallettstruct cvmx_shmem_smdr *cvmx_shmem_init(void); 102215976Sjmallett 103215976Sjmallett/** 104215976Sjmallett * Create a piece memory out of named block 105215976Sjmallett * 106215976Sjmallett * @param name Named block name 107215976Sjmallett * @param flag create flag 108215976Sjmallett */ 109215976Sjmallettstruct cvmx_shmem_dscptr *cvmx_shmem_named_block_open(char *name, uint32_t size, int oflag); 110215976Sjmallett 111215976Sjmallett/** 112215976Sjmallett * Update TLB mapping based on the descriptor 113215976Sjmallett */ 114215976Sjmallettvoid* cvmx_shmem_map(struct cvmx_shmem_dscptr *desc, int pflag); 115215976Sjmallett 116215976Sjmallett/** 117215976Sjmallett * Remove the TLB mapping created for the descriptor 118215976Sjmallett */ 119215976Sjmallettvoid cvmx_shmem_unmap(struct cvmx_shmem_dscptr *desc); 120215976Sjmallett 121215976Sjmallett 122215976Sjmallett/** 123215976Sjmallett * Close the share memory, 124215976Sjmallett * 125215976Sjmallett * @Param remove Remove the named block if it is created by the application 126215976Sjmallett */ 127215976Sjmallettint cvmx_shmem_close(struct cvmx_shmem_dscptr *desc, int remove); 128215976Sjmallett 129215976Sjmallett/** 130215976Sjmallett * Debug function, dump all SMDR descriptors 131215976Sjmallett */ 132215976Sjmallettvoid cvmx_shmem_show(void); 133215976Sjmallett 134215976Sjmallett 135215976Sjmallett#ifdef __cplusplus 136215976Sjmallett} 137215976Sjmallett#endif 138215976Sjmallett 139215976Sjmallett#endif 140