summaryrefslogtreecommitdiff
path: root/drivers/stm/stm_fw.h
blob: bcaa307d0ad0c8c3e03f12e9e2c6805aba5e96f7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
/*
 * stm_fw.h
 *
 * System Trace Module (STM) Framework Driver API
 *
 * Copyright (C) 2012 Texas Instruments Incorporated - http://www.ti.com/
 *
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef _STM_FW_H
#define _STM_FW_H

enum stm_usecase {
	USER_CHANNEL_REQUEST,
	PRINTK_CHANNEL_REQUEST,
	TRACEPOINT_CHANEL_REQUEST,
	LTTNG_CHANNEL_REQUEST,
	REMOVE_CHANNEL_REQUEST,
	LAST_REQUEST
};

struct stm_global_info {
	int     total_chn_cnt;
	int     reserved_chn_cnt;
	int     user_allocated_chn_cnt;
	int     stm_module_clock_on;
	int     stm_module_enabled;
	char    *attribute_list;
};

struct stm_operations {
	char    *name;
	int     (*get_global_info)(struct stm_global_info *info);
	int     (*write) (void *chn_id, char *pbuf, int cnt, bool uspace,
			  bool timestamp);
	int     (*write_mark)(void *chn_id, char *pbuf, int cnt, bool uspace,
			      bool timestamp);
	int     (*allocate_channel) (enum stm_usecase uc_id, void **chn_id);
	int     (*free_channel) (void *chn_id);
	int     (*config_write)(void *chn_id, char *config_string);
	int     (*config_read)(void *chn_id, char *config_string, int count);
	int     (*mmap)(struct vm_area_struct *vma);
};

int stm_register(struct stm_operations *stm_ops);
int stm_unregister(void);

#endif