Mercurial > sdl-ios-xcode

annotate src/video/ps3/SDL_ps3spe_c.h @ 3157:cce01ba54174 gsoc2009_ps3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added comments, clean up.
author Martin Lowinski <martin@goldtopf.org>
date Thu, 27 Aug 2009 11:33:56 +0000
parents 0cf7bff804ad
children
rev   line source
3144
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
1 /*
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
2 SDL - Simple DirectMedia Layer
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
3 Copyright (C) 1997-2009 Sam Lantinga
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
4
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
5 This library is free software; you can redistribute it and/or
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
6 modify it under the terms of the GNU Lesser General Public
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
7 License as published by the Free Software Foundation; either
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
8 version 2.1 of the License, or (at your option) any later version.
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
9
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
10 This library is distributed in the hope that it will be useful,
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
13 Lesser General Public License for more details.
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
14
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
15 You should have received a copy of the GNU Lesser General Public
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
16 License along with this library; if not, write to the Free Software
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
18
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
19 Sam Lantinga
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
20 slouken@libsdl.org
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
21 */
3157
cce01ba54174 Added comments, clean up.
Martin Lowinski <martin@goldtopf.org>
parents: 3150
diff changeset
22
cce01ba54174 Added comments, clean up.
Martin Lowinski <martin@goldtopf.org>
parents: 3150
diff changeset
23 /* This SPE API basically provides 3 ways to run and control a program
cce01ba54174 Added comments, clean up.
Martin Lowinski <martin@goldtopf.org>
parents: 3150
diff changeset
24 * on the SPE:
cce01ba54174 Added comments, clean up.
Martin Lowinski <martin@goldtopf.org>
parents: 3150
diff changeset
25 * - Start and stop the program (keepalive=0).
cce01ba54174 Added comments, clean up.
Martin Lowinski <martin@goldtopf.org>
parents: 3150
diff changeset
26 * SPE_Start() will implicitly boot up the program, create a thread and run
cce01ba54174 Added comments, clean up.
Martin Lowinski <martin@goldtopf.org>
parents: 3150
diff changeset
27 * the context.
cce01ba54174 Added comments, clean up.
Martin Lowinski <martin@goldtopf.org>
parents: 3150
diff changeset
28 * SPE_Stop() will join the (terminated) thread (may block) and return.
cce01ba54174 Added comments, clean up.
Martin Lowinski <martin@goldtopf.org>
parents: 3150
diff changeset
29 * - Boot the program and run it (keepalive=0).
cce01ba54174 Added comments, clean up.
Martin Lowinski <martin@goldtopf.org>
parents: 3150
diff changeset
30 * SPE_Boot() will create a context and load the program and finally start
cce01ba54174 Added comments, clean up.
Martin Lowinski <martin@goldtopf.org>
parents: 3150
diff changeset
31 * the context with SPE_Start().
cce01ba54174 Added comments, clean up.
Martin Lowinski <martin@goldtopf.org>
parents: 3150
diff changeset
32 * SPE_Stop() will savely end the program.
cce01ba54174 Added comments, clean up.
Martin Lowinski <martin@goldtopf.org>
parents: 3150
diff changeset
33 * - Boot, Run and send messages to the program (keepalive=1).
cce01ba54174 Added comments, clean up.
Martin Lowinski <martin@goldtopf.org>
parents: 3150
diff changeset
34 * Start the program by using one of the methods described above. When
cce01ba54174 Added comments, clean up.
Martin Lowinski <martin@goldtopf.org>
parents: 3150
diff changeset
35 * received the READY-message the program is in its infinite loop waiting
cce01ba54174 Added comments, clean up.
Martin Lowinski <martin@goldtopf.org>
parents: 3150
diff changeset
36 * for new messages.
cce01ba54174 Added comments, clean up.
Martin Lowinski <martin@goldtopf.org>
parents: 3150
diff changeset
37 * Every time you run the program, send SPU_START and the address of the
cce01ba54174 Added comments, clean up.
Martin Lowinski <martin@goldtopf.org>
parents: 3150
diff changeset
38 * according struct using SPE_SendMsg().
cce01ba54174 Added comments, clean up.
Martin Lowinski <martin@goldtopf.org>
parents: 3150
diff changeset
39 * SPE_WaitForMsg() will than wait for SPU_FIN and is blocking.
cce01ba54174 Added comments, clean up.
Martin Lowinski <martin@goldtopf.org>
parents: 3150
diff changeset
40 * SPE_Shutdown() sends SPU_EXIT and finally stops the program.
cce01ba54174 Added comments, clean up.
Martin Lowinski <martin@goldtopf.org>
parents: 3150
diff changeset
41 *
cce01ba54174 Added comments, clean up.
Martin Lowinski <martin@goldtopf.org>
parents: 3150
diff changeset
42 * Therefor the SPE program
cce01ba54174 Added comments, clean up.
Martin Lowinski <martin@goldtopf.org>
parents: 3150
diff changeset
43 * - either runs once and returns
cce01ba54174 Added comments, clean up.
Martin Lowinski <martin@goldtopf.org>
parents: 3150
diff changeset
44 * - or runs in an infinite loop and is controlled by messages.
cce01ba54174 Added comments, clean up.
Martin Lowinski <martin@goldtopf.org>
parents: 3150
diff changeset
45 */
cce01ba54174 Added comments, clean up.
Martin Lowinski <martin@goldtopf.org>
parents: 3150
diff changeset
46
3144
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
47 #include "SDL_config.h"
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
48
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
49 #include "spulibs/spu_common.h"
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
50
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
51 #include <libspe2.h>
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
52
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
53 #ifndef _SDL_ps3spe_h
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
54 #define _SDL_ps3spe_h
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
55
3150
0cf7bff804ad Code reviewed and added SPE API documentation.
Martin Lowinski <martin@goldtopf.org>
parents: 3144
diff changeset
56 /* SPU handling data */
3144
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
57 typedef struct spu_data {
3150
0cf7bff804ad Code reviewed and added SPE API documentation.
Martin Lowinski <martin@goldtopf.org>
parents: 3144
diff changeset
58 /* Context to be executed */
3144
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
59 spe_context_ptr_t ctx;
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
60 spe_program_handle_t program;
3150
0cf7bff804ad Code reviewed and added SPE API documentation.
Martin Lowinski <martin@goldtopf.org>
parents: 3144
diff changeset
61 /* Thread running the context */
3144
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
62 pthread_t thread;
3150
0cf7bff804ad Code reviewed and added SPE API documentation.
Martin Lowinski <martin@goldtopf.org>
parents: 3144
diff changeset
63 /* For debugging */
3144
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
64 char * program_name;
3150
0cf7bff804ad Code reviewed and added SPE API documentation.
Martin Lowinski <martin@goldtopf.org>
parents: 3144
diff changeset
65 /* SPE_Start() or SPE_Boot() called */
3144
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
66 unsigned int booted;
3150
0cf7bff804ad Code reviewed and added SPE API documentation.
Martin Lowinski <martin@goldtopf.org>
parents: 3144
diff changeset
67 /* Runs the program in an infinite loop? */
3144
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
68 unsigned int keepalive;
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
69 unsigned int entry;
3150
0cf7bff804ad Code reviewed and added SPE API documentation.
Martin Lowinski <martin@goldtopf.org>
parents: 3144
diff changeset
70 /* Exit code of the program */
3144
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
71 int error_code;
3150
0cf7bff804ad Code reviewed and added SPE API documentation.
Martin Lowinski <martin@goldtopf.org>
parents: 3144
diff changeset
72 /* Arguments passed to the program */
3144
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
73 void * argp;
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
74 } spu_data_t;
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
75
3150
0cf7bff804ad Code reviewed and added SPE API documentation.
Martin Lowinski <martin@goldtopf.org>
parents: 3144
diff changeset
76 /* SPU specific API functions */
3144
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
77 int SPE_Start(spu_data_t * spe_data);
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
78 int SPE_Stop(spu_data_t * spe_data);
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
79 int SPE_Boot(spu_data_t * spe_data);
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
80 int SPE_Shutdown(spu_data_t * spe_data);
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
81 int SPE_SendMsg(spu_data_t * spe_data, unsigned int msg);
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
82 int SPE_WaitForMsg(spu_data_t * spe_data, unsigned int msg);
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
83 void SPE_RunContext(void *thread_argp);
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
84
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
85 #endif /* _SDL_ps3spe_h */
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
86
0d8d1f870964 Moved SPE-functions to SDL_ps3spe.c.
Martin Lowinski <martin@goldtopf.org>
parents:
diff changeset
87 /* vi: set ts=4 sw=4 expandtab: */