annotate packages/services/cpuload/current/include/cpuload.h @ 2729:74dbf4c3f2e1 after-copyright-change-20090129

Update all copyright banners to reflect FSF ownership; fix and improve licence text.
author jlarmour
date Thu, 29 Jan 2009 17:47:46 +0000
parents 7de36227e601
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
301
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
1 //==========================================================================
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
2 //
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
3 // cpuload.h
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
4 //
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
5 // Interface for the cpuload code.
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
6 //
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
7 //==========================================================================
2729
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 301
diff changeset
8 // ####ECOSGPLCOPYRIGHTBEGIN####
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 301
diff changeset
9 // -------------------------------------------
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 301
diff changeset
10 // This file is part of eCos, the Embedded Configurable Operating System.
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 301
diff changeset
11 // Copyright (C) 2002 Free Software Foundation, Inc.
301
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
12 //
2729
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 301
diff changeset
13 // eCos is free software; you can redistribute it and/or modify it under
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 301
diff changeset
14 // the terms of the GNU General Public License as published by the Free
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 301
diff changeset
15 // Software Foundation; either version 2 or (at your option) any later
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 301
diff changeset
16 // version.
301
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
17 //
2729
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 301
diff changeset
18 // eCos is distributed in the hope that it will be useful, but WITHOUT
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 301
diff changeset
19 // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 301
diff changeset
20 // FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 301
diff changeset
21 // for more details.
301
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
22 //
2729
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 301
diff changeset
23 // You should have received a copy of the GNU General Public License
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 301
diff changeset
24 // along with eCos; if not, write to the Free Software Foundation, Inc.,
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 301
diff changeset
25 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
301
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
26 //
2729
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 301
diff changeset
27 // As a special exception, if other files instantiate templates or use
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 301
diff changeset
28 // macros or inline functions from this file, or you compile this file
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 301
diff changeset
29 // and link it with other works to produce a work based on this file,
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 301
diff changeset
30 // this file does not by itself cause the resulting work to be covered by
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 301
diff changeset
31 // the GNU General Public License. However the source code for this file
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 301
diff changeset
32 // must still be made available in accordance with section (3) of the GNU
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 301
diff changeset
33 // General Public License v2.
301
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
34 //
2729
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 301
diff changeset
35 // This exception does not invalidate any other reasons why a work based
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 301
diff changeset
36 // on this file might be covered by the GNU General Public License.
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 301
diff changeset
37 // -------------------------------------------
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 301
diff changeset
38 // ####ECOSGPLCOPYRIGHTEND####
301
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
39 //==========================================================================
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
40 //#####DESCRIPTIONBEGIN####
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
41 //
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
42 // Author(s): Andrew Lunn
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
43 // Contributors: Andrew Lunn
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
44 // Date: 2002-08-12
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
45 // Purpose:
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
46 // Description:
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
47 // API for the cpuload measurement code
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
48 //
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
49 // This code is part of eCos (tm).
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
50 //
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
51 //####DESCRIPTIONEND####
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
52 //
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
53 //==========================================================================
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
54
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
55 #ifndef _SERVICES_CPULOAD_CPULOAD_H
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
56 #define _SERVICES_CPULOAD_CPULOAD_H
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
57
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
58 #ifdef __cplusplus
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
59 externC
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
60 {
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
61 #endif
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
62
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
63 typedef struct cyg_cpuload_s {
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
64 cyg_alarm alarm_s;
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
65 cyg_handle_t alarmH;
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
66 cyg_uint32 last_idle_loops;
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
67 cyg_uint32 average_point1s;
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
68 cyg_uint32 average_1s;
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
69 cyg_uint32 average_10s;
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
70 cyg_uint32 calibration;
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
71 } cyg_cpuload_t;
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
72
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
73 /* Calibrate the CPU load measurement code */
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
74 void cyg_cpuload_calibrate(cyg_uint32 *calibration);
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
75
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
76 /* Create a measurement object and start the measurements */
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
77 void cyg_cpuload_create(cyg_cpuload_t *cpuload,
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
78 cyg_uint32 calibrate,
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
79 cyg_handle_t *handle);
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
80
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
81 /* Stop the measurements so the object can be freed */
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
82 void cyg_cpuload_delete(cyg_handle_t handle);
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
83
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
84 /* Get the current CPU load */
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
85 void cyg_cpuload_get(cyg_handle_t handle,
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
86 cyg_uint32 *average_point1s,
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
87 cyg_uint32 *average_1s,
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
88 cyg_uint32 *average_10s);
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
89
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
90 #ifdef __cplusplus
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
91 }
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
92 #endif
7de36227e601 * Created a new package with my CPU load measurement code which
asl
parents:
diff changeset
93 #endif /* _SERVICES_CPULOAD_CPULOAD_H */