1/* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3 * Cell Broadband Engine OProfile Support
4 *
5 * (C) Copyright IBM Corporation 2006
6 *
7 * Author: Maynard Johnson <maynardj@us.ibm.com>
8 */
9
10#ifndef PR_UTIL_H
11#define PR_UTIL_H
12
13#include <linux/cpumask.h>
14#include <linux/oprofile.h>
15#include <asm/cell-pmu.h>
16#include <asm/cell-regs.h>
17#include <asm/spu.h>
18
19/* Defines used for sync_start */
20#define SKIP_GENERIC_SYNC 0
21#define SYNC_START_ERROR -1
22#define DO_GENERIC_SYNC 1
23#define SPUS_PER_NODE   8
24#define DEFAULT_TIMER_EXPIRE  (HZ / 10)
25
26extern struct delayed_work spu_work;
27extern int spu_prof_running;
28
29#define TRACE_ARRAY_SIZE 1024
30
31extern spinlock_t oprof_spu_smpl_arry_lck;
32
33struct spu_overlay_info {	/* map of sections within an SPU overlay */
34	unsigned int vma;	/* SPU virtual memory address from elf */
35	unsigned int size;	/* size of section from elf */
36	unsigned int offset;	/* offset of section into elf file */
37	unsigned int buf;
38};
39
40struct vma_to_fileoffset_map {	/* map of sections within an SPU program */
41	struct vma_to_fileoffset_map *next;	/* list pointer */
42	unsigned int vma;	/* SPU virtual memory address from elf */
43	unsigned int size;	/* size of section from elf */
44	unsigned int offset;	/* offset of section into elf file */
45	unsigned int guard_ptr;
46	unsigned int guard_val;
47        /*
48	 * The guard pointer is an entry in the _ovly_buf_table,
49	 * computed using ovly.buf as the index into the table.  Since
50	 * ovly.buf values begin at '1' to reference the first (or 0th)
51	 * entry in the _ovly_buf_table, the computation subtracts 1
52	 * from ovly.buf.
53	 * The guard value is stored in the _ovly_buf_table entry and
54	 * is an index (starting at 1) back to the _ovly_table entry
55	 * that is pointing at this _ovly_buf_table entry.  So, for
56	 * example, for an overlay scenario with one overlay segment
57	 * and two overlay sections:
58	 *      - Section 1 points to the first entry of the
59	 *        _ovly_buf_table, which contains a guard value
60	 *        of '1', referencing the first (index=0) entry of
61	 *        _ovly_table.
62	 *      - Section 2 points to the second entry of the
63	 *        _ovly_buf_table, which contains a guard value
64	 *        of '2', referencing the second (index=1) entry of
65	 *        _ovly_table.
66	 */
67
68};
69
70struct spu_buffer {
71	int last_guard_val;
72	int ctx_sw_seen;
73	unsigned long *buff;
74	unsigned int head, tail;
75};
76
77
78/* The three functions below are for maintaining and accessing
79 * the vma-to-fileoffset map.
80 */
81struct vma_to_fileoffset_map *create_vma_map(const struct spu *spu,
82					     unsigned long objectid);
83unsigned int vma_map_lookup(struct vma_to_fileoffset_map *map,
84			    unsigned int vma, const struct spu *aSpu,
85			    int *grd_val);
86void vma_map_free(struct vma_to_fileoffset_map *map);
87
88/*
89 * Entry point for SPU profiling.
90 * cycles_reset is the SPU_CYCLES count value specified by the user.
91 */
92int start_spu_profiling_cycles(unsigned int cycles_reset);
93void start_spu_profiling_events(void);
94
95void stop_spu_profiling_cycles(void);
96void stop_spu_profiling_events(void);
97
98/* add the necessary profiling hooks */
99int spu_sync_start(void);
100
101/* remove the hooks */
102int spu_sync_stop(void);
103
104/* Record SPU program counter samples to the oprofile event buffer. */
105void spu_sync_buffer(int spu_num, unsigned int *samples,
106		     int num_samples);
107
108void set_spu_profiling_frequency(unsigned int freq_khz, unsigned int cycles_reset);
109
110#endif	  /* PR_UTIL_H */
111