1 /* 2 * Copyright (c) 2018, Mellanox Technologies. All rights reserved. 3 * 4 * This software is available to you under a choice of one of two 5 * licenses. You may choose to be licensed under the terms of the GNU 6 * General Public License (GPL) Version 2, available from the file 7 * COPYING in the main directory of this source tree, or the 8 * OpenIB.org BSD license below: 9 * 10 * Redistribution and use in source and binary forms, with or 11 * without modification, are permitted provided that the following 12 * conditions are met: 13 * 14 * - Redistributions of source code must retain the above 15 * copyright notice, this list of conditions and the following 16 * disclaimer. 17 * 18 * - Redistributions in binary form must reproduce the above 19 * copyright notice, this list of conditions and the following 20 * disclaimer in the documentation and/or other materials 21 * provided with the distribution. 22 * 23 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 24 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 25 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 26 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS 27 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN 28 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 29 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 30 * SOFTWARE. 31 */ 32 33 #ifndef __LIB_TRACER_H__ 34 #define __LIB_TRACER_H__ 35 36 #include <linux/mlx5/driver.h> 37 #include "mlx5_core.h" 38 39 #define STRINGS_DB_SECTIONS_NUM 8 40 #define STRINGS_DB_READ_SIZE_BYTES 256 41 #define STRINGS_DB_LEFTOVER_SIZE_BYTES 64 42 #define TRACER_BUFFER_PAGE_NUM 64 43 #define TRACER_BUFFER_CHUNK 4096 44 #define TRACE_BUFFER_SIZE_BYTE (TRACER_BUFFER_PAGE_NUM * TRACER_BUFFER_CHUNK) 45 46 #define TRACER_BLOCK_SIZE_BYTE 256 47 #define TRACES_PER_BLOCK 32 48 49 #define TRACER_MAX_PARAMS 7 50 #define MESSAGE_HASH_BITS 6 51 #define MESSAGE_HASH_SIZE BIT(MESSAGE_HASH_BITS) 52 53 #define MASK_52_7 (0x1FFFFFFFFFFF80) 54 #define MASK_6_0 (0x7F) 55 56 struct mlx5_fw_tracer { 57 struct mlx5_core_dev *dev; 58 struct mlx5_nb nb; 59 bool owner; 60 u8 trc_ver; 61 struct workqueue_struct *work_queue; 62 struct work_struct ownership_change_work; 63 struct work_struct read_fw_strings_work; 64 65 /* Strings DB */ 66 struct { 67 u8 first_string_trace; 68 u8 num_string_trace; 69 u32 num_string_db; 70 u32 base_address_out[STRINGS_DB_SECTIONS_NUM]; 71 u32 size_out[STRINGS_DB_SECTIONS_NUM]; 72 void *buffer[STRINGS_DB_SECTIONS_NUM]; 73 bool loaded; 74 } str_db; 75 76 /* Log Buffer */ 77 struct { 78 u32 pdn; 79 void *log_buf; 80 dma_addr_t dma; 81 u32 size; 82 struct mlx5_core_mkey mkey; 83 u32 consumer_index; 84 } buff; 85 86 u64 last_timestamp; 87 struct work_struct handle_traces_work; 88 struct hlist_head hash[MESSAGE_HASH_SIZE]; 89 struct list_head ready_strings_list; 90 }; 91 92 struct tracer_string_format { 93 char *string; 94 int params[TRACER_MAX_PARAMS]; 95 int num_of_params; 96 int last_param_num; 97 u8 event_id; 98 u32 tmsn; 99 struct hlist_node hlist; 100 struct list_head list; 101 u32 timestamp; 102 bool lost; 103 }; 104 105 enum mlx5_fw_tracer_ownership_state { 106 MLX5_FW_TRACER_RELEASE_OWNERSHIP, 107 MLX5_FW_TRACER_ACQUIRE_OWNERSHIP, 108 }; 109 110 enum tracer_ctrl_fields_select { 111 TRACE_STATUS = 1 << 0, 112 }; 113 114 enum tracer_event_type { 115 TRACER_EVENT_TYPE_STRING, 116 TRACER_EVENT_TYPE_TIMESTAMP = 0xFF, 117 TRACER_EVENT_TYPE_UNRECOGNIZED, 118 }; 119 120 enum tracing_mode { 121 TRACE_TO_MEMORY = 1 << 0, 122 }; 123 124 struct tracer_timestamp_event { 125 u64 timestamp; 126 u8 unreliable; 127 }; 128 129 struct tracer_string_event { 130 u32 timestamp; 131 u32 tmsn; 132 u32 tdsn; 133 u32 string_param; 134 }; 135 136 struct tracer_event { 137 bool lost_event; 138 u32 type; 139 u8 event_id; 140 union { 141 struct tracer_string_event string_event; 142 struct tracer_timestamp_event timestamp_event; 143 }; 144 }; 145 146 struct mlx5_ifc_tracer_event_bits { 147 u8 lost[0x1]; 148 u8 timestamp[0x7]; 149 u8 event_id[0x8]; 150 u8 event_data[0x30]; 151 }; 152 153 struct mlx5_ifc_tracer_string_event_bits { 154 u8 lost[0x1]; 155 u8 timestamp[0x7]; 156 u8 event_id[0x8]; 157 u8 tmsn[0xd]; 158 u8 tdsn[0x3]; 159 u8 string_param[0x20]; 160 }; 161 162 struct mlx5_ifc_tracer_timestamp_event_bits { 163 u8 timestamp7_0[0x8]; 164 u8 event_id[0x8]; 165 u8 urts[0x3]; 166 u8 timestamp52_40[0xd]; 167 u8 timestamp39_8[0x20]; 168 }; 169 170 struct mlx5_fw_tracer *mlx5_fw_tracer_create(struct mlx5_core_dev *dev); 171 int mlx5_fw_tracer_init(struct mlx5_fw_tracer *tracer); 172 void mlx5_fw_tracer_cleanup(struct mlx5_fw_tracer *tracer); 173 void mlx5_fw_tracer_destroy(struct mlx5_fw_tracer *tracer); 174 175 #endif 176