Imported Upstream version 3.2.2
[debian/gnuradio] / gcell / include / gcell / gc_declare_proc.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2008 Free Software Foundation, Inc.
4  * 
5  * This file is part of GNU Radio
6  * 
7  * GNU Radio is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3, or (at your option)
10  * any later version.
11  * 
12  * GNU Radio is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License along
18  * with this program; if not, write to the Free Software Foundation, Inc.,
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20  */
21 #ifndef INCLUDED_GCELL_GC_DECLARE_PROC_H
22 #define INCLUDED_GCELL_GC_DECLARE_PROC_H
23
24 #include <stdint.h>
25 #include <gcell/gc_job_desc.h>
26
27 /*
28  * This is C, not C++ code...
29  *
30  * ...and is used by both PPE and SPE code
31  */
32 __GC_BEGIN_DECLS
33
34 #define GC_PROC_DEF_SECTION ".gcell.proc_def"
35
36 typedef struct gc_proc_def {
37 #if defined(__SPU__)
38   gc_spu_proc_t proc;
39 #else
40   uint32_t      proc;
41 #endif
42   char          name[28];
43 } _AL16 gc_proc_def_t;
44
45
46 #if defined(__SPU__)
47 /*!
48  * \brief Tell gcell about a SPU procedure
49  *
50  * \param _proc_   pointer to function (gc_spu_proc_t)
51  * \param _name_   the name of the procedure ("quoted string")
52  *
53  * This macro registers the given procedure with the gcell runtime.
54  * From the PPE, use gc_job_manager::lookup_proc to map \p _name_ to a gc_proc_id_t
55  */
56 #define GC_DECLARE_PROC(_proc_, _name_) \
57 static struct gc_proc_def \
58   _GCPD_ ## _proc_ __attribute__((section(GC_PROC_DEF_SECTION), used)) = \
59   { _proc_, _name_ }
60 #endif
61
62 __GC_END_DECLS
63
64 #endif /* INCLUDED_GCELL_GC_DECLARE_PROC_H */