cvmx-helper-fpa.h revision 210286 
1/***********************license start***************
2 *  Copyright (c) 2003-2008 Cavium Networks (support@cavium.com). All rights
3 *  reserved.
4 *
5 *
6 *  Redistribution and use in source and binary forms, with or without
7 *  modification, are permitted provided that the following conditions are
8 *  met:
9 *
10 *      * Redistributions of source code must retain the above copyright
11 *        notice, this list of conditions and the following disclaimer.
12 *
13 *      * Redistributions in binary form must reproduce the above
14 *        copyright notice, this list of conditions and the following
15 *        disclaimer in the documentation and/or other materials provided
16 *        with the distribution.
17 *
18 *      * Neither the name of Cavium Networks nor the names of
19 *        its contributors may be used to endorse or promote products
20 *        derived from this software without specific prior written
21 *        permission.
22 *
23 *  TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS"
24 *  AND WITH ALL FAULTS AND CAVIUM NETWORKS MAKES NO PROMISES, REPRESENTATIONS
25 *  OR WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH
26 *  RESPECT TO THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY
27 *  REPRESENTATION OR DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT
28 *  DEFECTS, AND CAVIUM SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES
29 *  OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR
30 *  PURPOSE, LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET
31 *  POSSESSION OR CORRESPONDENCE TO DESCRIPTION.  THE ENTIRE RISK ARISING OUT
32 *  OF USE OR PERFORMANCE OF THE SOFTWARE LIES WITH YOU.
33 *
34 *
35 *  For any questions regarding licensing please contact marketing@caviumnetworks.com
36 *
37 ***********************license end**************************************/
38
39
40
41
42
43
44/**
45 * @file
46 *
47 * Helper functions for FPA setup.
48 *
49 * <hr>$Revision: 41586 $<hr>
50 */
51#ifndef __CVMX_HELPER_H_FPA__
52#define __CVMX_HELPER_H_FPA__
53
54/**
55 * Allocate memory and initialize the FPA pools using memory
56 * from cvmx-bootmem. Sizes of each element in the pools is
57 * controlled by the cvmx-config.h header file. Specifying
58 * zero for any parameter will cause that FPA pool to not be
59 * setup. This is useful if you aren't using some of the
60 * hardware and want to save memory.
61 *
62 * @param packet_buffers
63 *               Number of packet buffers to allocate
64 * @param work_queue_entries
65 *               Number of work queue entries
66 * @param pko_buffers
67 *               PKO Command buffers. You should at minimum have two per
68 *               each PKO queue.
69 * @param tim_buffers
70 *               TIM ring buffer command queues. At least two per timer bucket
71 *               is recommened.
72 * @param dfa_buffers
73 *               DFA command buffer. A relatively small (32 for example)
74 *               number should work.
75 * @return Zero on success, non-zero if out of memory
76 */
77extern int cvmx_helper_initialize_fpa(int packet_buffers, int work_queue_entries,
78                                      int pko_buffers, int tim_buffers,
79                                      int dfa_buffers);
80
81#endif  /* __CVMX_HELPER_H__ */
82