1210284Sjmallett/***********************license start*************** 2232812Sjmallett * Copyright (c) 2003-2010 Cavium Inc. (support@cavium.com). All rights 3215990Sjmallett * reserved. 4210284Sjmallett * 5210284Sjmallett * 6215990Sjmallett * Redistribution and use in source and binary forms, with or without 7215990Sjmallett * modification, are permitted provided that the following conditions are 8215990Sjmallett * met: 9210284Sjmallett * 10215990Sjmallett * * Redistributions of source code must retain the above copyright 11215990Sjmallett * notice, this list of conditions and the following disclaimer. 12210284Sjmallett * 13215990Sjmallett * * Redistributions in binary form must reproduce the above 14215990Sjmallett * copyright notice, this list of conditions and the following 15215990Sjmallett * disclaimer in the documentation and/or other materials provided 16215990Sjmallett * with the distribution. 17210284Sjmallett 18232812Sjmallett * * Neither the name of Cavium Inc. nor the names of 19215990Sjmallett * its contributors may be used to endorse or promote products 20215990Sjmallett * derived from this software without specific prior written 21215990Sjmallett * permission. 22210284Sjmallett 23215990Sjmallett * This Software, including technical data, may be subject to U.S. export control 24215990Sjmallett * laws, including the U.S. Export Administration Act and its associated 25215990Sjmallett * regulations, and may be subject to export or import regulations in other 26215990Sjmallett * countries. 27210284Sjmallett 28215990Sjmallett * 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 30215990Sjmallett * WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT TO 31215990Sjmallett * THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY REPRESENTATION OR 32215990Sjmallett * DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT DEFECTS, AND CAVIUM 33215990Sjmallett * SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES OF TITLE, 34215990Sjmallett * MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR PURPOSE, LACK OF 35215990Sjmallett * VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET POSSESSION OR 36215990Sjmallett * CORRESPONDENCE TO DESCRIPTION. THE ENTIRE RISK ARISING OUT OF USE OR 37215990Sjmallett * PERFORMANCE OF THE SOFTWARE LIES WITH YOU. 38215990Sjmallett ***********************license end**************************************/ 39210284Sjmallett 40210284Sjmallett 41210284Sjmallett/** 42210284Sjmallett * @file 43210284Sjmallett * 44210284Sjmallett * Support library for the hardware Free Pool Allocator. 45210284Sjmallett * 46232812Sjmallett * <hr>$Revision: 70030 $<hr> 47210284Sjmallett * 48210284Sjmallett */ 49210284Sjmallett 50210284Sjmallett#include "cvmx.h" 51210284Sjmallett#include "cvmx-fpa.h" 52210284Sjmallett#include "cvmx-ipd.h" 53210284Sjmallett 54210284Sjmallett/** 55210284Sjmallett * Current state of all the pools. Use access functions 56210284Sjmallett * instead of using it directly. 57210284Sjmallett */ 58210284SjmallettCVMX_SHARED cvmx_fpa_pool_info_t cvmx_fpa_pool_info[CVMX_FPA_NUM_POOLS]; 59210284Sjmallett 60210284Sjmallett 61210284Sjmallett/** 62210284Sjmallett * Setup a FPA pool to control a new block of memory. The 63210284Sjmallett * buffer pointer must be a physical address. 64210284Sjmallett * 65210284Sjmallett * @param pool Pool to initialize 66210284Sjmallett * 0 <= pool < 8 67210284Sjmallett * @param name Constant character string to name this pool. 68210284Sjmallett * String is not copied. 69210284Sjmallett * @param buffer Pointer to the block of memory to use. This must be 70210284Sjmallett * accessable by all processors and external hardware. 71210284Sjmallett * @param block_size Size for each block controlled by the FPA 72210284Sjmallett * @param num_blocks Number of blocks 73210284Sjmallett * 74210284Sjmallett * @return 0 on Success, 75210284Sjmallett * -1 on failure 76210284Sjmallett */ 77210284Sjmallettint cvmx_fpa_setup_pool(uint64_t pool, const char *name, void *buffer, 78210284Sjmallett uint64_t block_size, uint64_t num_blocks) 79210284Sjmallett{ 80210284Sjmallett char *ptr; 81210284Sjmallett if (!buffer) 82210284Sjmallett { 83210284Sjmallett cvmx_dprintf("ERROR: cvmx_fpa_setup_pool: NULL buffer pointer!\n"); 84215990Sjmallett return -1; 85210284Sjmallett } 86210284Sjmallett if (pool >= CVMX_FPA_NUM_POOLS) 87210284Sjmallett { 88210284Sjmallett cvmx_dprintf("ERROR: cvmx_fpa_setup_pool: Illegal pool!\n"); 89215990Sjmallett return -1; 90210284Sjmallett } 91210284Sjmallett 92210284Sjmallett if (block_size < CVMX_FPA_MIN_BLOCK_SIZE) 93210284Sjmallett { 94210284Sjmallett cvmx_dprintf("ERROR: cvmx_fpa_setup_pool: Block size too small.\n"); 95215990Sjmallett return -1; 96210284Sjmallett } 97210284Sjmallett 98210284Sjmallett if (((unsigned long)buffer & (CVMX_FPA_ALIGNMENT-1)) != 0) 99210284Sjmallett { 100210284Sjmallett cvmx_dprintf("ERROR: cvmx_fpa_setup_pool: Buffer not aligned properly.\n"); 101215990Sjmallett return -1; 102210284Sjmallett } 103210284Sjmallett 104210284Sjmallett cvmx_fpa_pool_info[pool].name = name; 105210284Sjmallett cvmx_fpa_pool_info[pool].size = block_size; 106210284Sjmallett cvmx_fpa_pool_info[pool].starting_element_count = num_blocks; 107210284Sjmallett cvmx_fpa_pool_info[pool].base = buffer; 108210284Sjmallett 109210284Sjmallett ptr = (char*)buffer; 110210284Sjmallett while (num_blocks--) 111210284Sjmallett { 112210284Sjmallett cvmx_fpa_free(ptr, pool, 0); 113210284Sjmallett ptr += block_size; 114210284Sjmallett } 115215990Sjmallett return 0; 116210284Sjmallett} 117210284Sjmallett 118210284Sjmallett/** 119210284Sjmallett * Shutdown a Memory pool and validate that it had all of 120215990Sjmallett * the buffers originally placed in it. This should only be 121215990Sjmallett * called by one processor after all hardware has finished 122215990Sjmallett * using the pool. Most like you will want to have called 123215990Sjmallett * cvmx_helper_shutdown_packet_io_global() before this 124215990Sjmallett * function to make sure all FPA buffers are out of the packet 125215990Sjmallett * IO hardware. 126210284Sjmallett * 127210284Sjmallett * @param pool Pool to shutdown 128215990Sjmallett * 129210284Sjmallett * @return Zero on success 130210284Sjmallett * - Positive is count of missing buffers 131210284Sjmallett * - Negative is too many buffers or corrupted pointers 132210284Sjmallett */ 133210284Sjmallettuint64_t cvmx_fpa_shutdown_pool(uint64_t pool) 134210284Sjmallett{ 135215990Sjmallett int errors = 0; 136215990Sjmallett int count = 0; 137215990Sjmallett int expected_count = cvmx_fpa_pool_info[pool].starting_element_count; 138210284Sjmallett uint64_t base = cvmx_ptr_to_phys(cvmx_fpa_pool_info[pool].base); 139215990Sjmallett uint64_t finish = base + cvmx_fpa_pool_info[pool].size * expected_count; 140210284Sjmallett 141210284Sjmallett count = 0; 142215990Sjmallett while (1) 143210284Sjmallett { 144215990Sjmallett uint64_t address; 145215990Sjmallett void *ptr = cvmx_fpa_alloc(pool); 146215990Sjmallett if (!ptr) 147215990Sjmallett break; 148215990Sjmallett 149215990Sjmallett address = cvmx_ptr_to_phys(ptr); 150215990Sjmallett if ((address >= base) && (address < finish) && 151215990Sjmallett (((address - base) % cvmx_fpa_pool_info[pool].size) == 0)) 152215990Sjmallett { 153215990Sjmallett count++; 154215990Sjmallett } 155210284Sjmallett else 156210284Sjmallett { 157215990Sjmallett cvmx_dprintf("ERROR: cvmx_fpa_shutdown_pool: Illegal address 0x%llx in pool %s(%d)\n", 158215990Sjmallett (unsigned long long)address, cvmx_fpa_pool_info[pool].name, (int)pool); 159215990Sjmallett errors++; 160210284Sjmallett } 161215990Sjmallett } 162210284Sjmallett 163215990Sjmallett if (count < expected_count) 164215990Sjmallett { 165215990Sjmallett cvmx_dprintf("ERROR: cvmx_fpa_shutdown_pool: Pool %s(%d) missing %d buffers\n", 166215990Sjmallett cvmx_fpa_pool_info[pool].name, (int)pool, expected_count - count); 167215990Sjmallett } 168215990Sjmallett else if (count > expected_count) 169215990Sjmallett { 170215990Sjmallett cvmx_dprintf("ERROR: cvmx_fpa_shutdown_pool: Pool %s(%d) had %d duplicate buffers\n", 171215990Sjmallett cvmx_fpa_pool_info[pool].name, (int)pool, count - expected_count); 172215990Sjmallett } 173210284Sjmallett 174210284Sjmallett if (errors) 175210284Sjmallett { 176215990Sjmallett cvmx_dprintf("ERROR: cvmx_fpa_shutdown_pool: Pool %s(%d) started at 0x%llx, ended at 0x%llx, with a step of 0x%x\n", 177215990Sjmallett cvmx_fpa_pool_info[pool].name, (int)pool, (unsigned long long)base, (unsigned long long)finish, (int)cvmx_fpa_pool_info[pool].size); 178210284Sjmallett return -errors; 179210284Sjmallett } 180210284Sjmallett else 181215990Sjmallett return expected_count - count; 182210284Sjmallett} 183210284Sjmallett 184210284Sjmallettuint64_t cvmx_fpa_get_block_size(uint64_t pool) 185210284Sjmallett{ 186210284Sjmallett switch (pool) 187210284Sjmallett { 188215990Sjmallett case 0: 189215990Sjmallett return CVMX_FPA_POOL_0_SIZE; 190215990Sjmallett case 1: 191215990Sjmallett return CVMX_FPA_POOL_1_SIZE; 192215990Sjmallett case 2: 193215990Sjmallett return CVMX_FPA_POOL_2_SIZE; 194215990Sjmallett case 3: 195215990Sjmallett return CVMX_FPA_POOL_3_SIZE; 196215990Sjmallett case 4: 197215990Sjmallett return CVMX_FPA_POOL_4_SIZE; 198215990Sjmallett case 5: 199215990Sjmallett return CVMX_FPA_POOL_5_SIZE; 200215990Sjmallett case 6: 201215990Sjmallett return CVMX_FPA_POOL_6_SIZE; 202215990Sjmallett case 7: 203215990Sjmallett return CVMX_FPA_POOL_7_SIZE; 204215990Sjmallett default: 205215990Sjmallett return 0; 206210284Sjmallett } 207210284Sjmallett} 208