1/***********************license start***************
2 * Copyright (c) 2003-2010  Cavium Inc. (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 Inc. 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 * This Software, including technical data, may be subject to U.S. export  control
24 * laws, including the U.S. Export Administration Act and its  associated
25 * regulations, and may be subject to export or import  regulations in other
26 * countries.
27
28 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS"
29 * AND WITH ALL FAULTS AND CAVIUM INC. MAKES NO PROMISES, REPRESENTATIONS OR
30 * WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT TO
31 * THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY REPRESENTATION OR
32 * DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT DEFECTS, AND CAVIUM
33 * SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES OF TITLE,
34 * MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR PURPOSE, LACK OF
35 * VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET POSSESSION OR
36 * CORRESPONDENCE TO DESCRIPTION. THE ENTIRE  RISK ARISING OUT OF USE OR
37 * PERFORMANCE OF THE SOFTWARE LIES WITH YOU.
38 ***********************license end**************************************/
39
40
41
42
43
44
45
46/**
47 * @file
48 *
49 * Helper functions for FPA setup.
50 *
51 * <hr>$Revision: 70030 $<hr>
52 */
53#ifndef __CVMX_HELPER_H_FPA__
54#define __CVMX_HELPER_H_FPA__
55
56/**
57 * Allocate memory and initialize the FPA pools using memory
58 * from cvmx-bootmem. Sizes of each element in the pools is
59 * controlled by the cvmx-config.h header file. Specifying
60 * zero for any parameter will cause that FPA pool to not be
61 * setup. This is useful if you aren't using some of the
62 * hardware and want to save memory.
63 *
64 * @param packet_buffers
65 *               Number of packet buffers to allocate
66 * @param work_queue_entries
67 *               Number of work queue entries
68 * @param pko_buffers
69 *               PKO Command buffers. You should at minimum have two per
70 *               each PKO queue.
71 * @param tim_buffers
72 *               TIM ring buffer command queues. At least two per timer bucket
73 *               is recommended.
74 * @param dfa_buffers
75 *               DFA command buffer. A relatively small (32 for example)
76 *               number should work.
77 * @return Zero on success, non-zero if out of memory
78 */
79extern int cvmx_helper_initialize_fpa(int packet_buffers, int work_queue_entries,
80                                      int pko_buffers, int tim_buffers,
81                                      int dfa_buffers);
82
83#endif  /* __CVMX_HELPER_H__ */
84