File: parse_log_sense.h

package info (click to toggle)
diskscan 0.21-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,656 kB
  • sloc: ansic: 11,136; python: 338; xml: 138; sh: 41; makefile: 36
file content (156 lines) | stat: -rw-r--r-- 4,285 bytes parent folder | download | duplicates (5)
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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
/* Copyright 2015 Baruch Even
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

#ifndef LIBSCSICMD_LOG_SENSE_H
#define LIBSCSICMD_LOG_SENSE_H

#include "scsicmd_utils.h"
#include <stdint.h>
#include <stdbool.h>

/* Log Sense Header decode */

#define LOG_SENSE_MIN_LEN 4

static inline uint8_t log_sense_page_code(uint8_t *data)
{
	return data[0] & 0x3F;
}

static inline bool log_sense_subpage_format(uint8_t *data)
{
	return data[0] & 0x40;
}

static inline bool log_sense_data_saved(uint8_t *data)
{
	return data[0] & 0x80;
}

static inline uint8_t log_sense_subpage_code(uint8_t *data)
{
	return data[1];
}

static inline unsigned log_sense_data_len(uint8_t *data)
{
	return get_uint16(data, 2);
}

static inline uint8_t *log_sense_data(uint8_t *data)
{
	return data + LOG_SENSE_MIN_LEN;
}

static inline uint8_t *log_sense_data_end(uint8_t *data, unsigned data_len)
{
	return data + safe_len(data, data_len, log_sense_data(data), log_sense_data_len(data));
}

static inline bool log_sense_is_valid(uint8_t *data, unsigned data_len)
{
	if (data_len < LOG_SENSE_MIN_LEN)
		return false;
	if (!log_sense_subpage_format(data) && log_sense_subpage_code(data) != 0)
		return false;
	if (log_sense_data_len(data) + LOG_SENSE_MIN_LEN < data_len)
		return false;
	return true;
}

/* Log Sense Parameter decode */
#define LOG_SENSE_MIN_PARAM_LEN 4

#define LOG_PARAM_FLAG_DU 0x80
#define LOG_PARAM_FLAG_TSD 0x20
#define LOG_PARAM_FLAG_ETC 0x10
#define LOG_PARAM_FLAG_TMC_MASK 0x0C
#define LOG_PARAM_FLAG_FMT_MASK 0x03

#define LOG_PARAM_TMC_EVERY_UPDATE 0
#define LOG_PARAM_TMC_EQUAL 1
#define LOG_PARAM_TMC_NOT_EQUAL 2
#define LOG_PARAM_TMC_GREATER 3

#define LOG_PARAM_FMT_COUNTER_STOP 0
#define LOG_PARAM_FMT_ASCII 1
#define LOG_PARAM_FMT_COUNTER_ROLLOVER 2
#define LOG_PARAM_FMT_BINARY 2

static inline uint16_t log_sense_param_code(uint8_t *param)
{
	return get_uint16(param, 0);
}

inline static uint8_t log_sense_param_flags(uint8_t *param)
{
	return param[2];
}

inline static uint8_t log_sense_param_tmc(uint8_t *param)
{
	return (log_sense_param_flags(param) & LOG_PARAM_FLAG_TMC_MASK) >> 2;
}

inline static uint8_t log_sense_param_fmt(uint8_t *param)
{
	return log_sense_param_flags(param) & LOG_PARAM_FLAG_FMT_MASK;
}

static inline unsigned log_sense_param_len(uint8_t *param)
{
	return param[3];
}

static inline uint8_t *log_sense_param_data(uint8_t *param)
{
	return param + LOG_SENSE_MIN_PARAM_LEN;
}

static inline bool log_sense_param_is_valid(uint8_t *data, unsigned data_len, uint8_t *param)
{
	if (param < data)
		return false;

	const unsigned param_offset = param - data;
	if (param_offset > data_len)
		return false;

	if (param_offset + LOG_SENSE_MIN_PARAM_LEN > data_len)
		return false;

	if (param_offset + LOG_SENSE_MIN_PARAM_LEN + log_sense_param_len(param) > data_len)
		return false;

	return true;
}

#define for_all_log_sense_params(data, data_len, param) \
	for (param = log_sense_data(data); \
		 log_sense_param_is_valid(data, data_len, param); \
		 param = param + LOG_SENSE_MIN_PARAM_LEN + log_sense_param_len(param))

#define for_all_log_sense_pg_0_supported_pages(data, data_len, supported_page) \
	uint8_t *__tmp; \
	for (__tmp = log_sense_data(data), supported_page = __tmp[0]; __tmp < log_sense_data_end(data, data_len); __tmp++, supported_page = __tmp[0])

#define for_all_log_sense_pg_0_supported_subpages(data, data_len, supported_page, supported_subpage) \
	uint8_t *__tmp; \
	for (__tmp = log_sense_data(data), supported_page = __tmp[0], supported_subpage = __tmp[1]; __tmp + 1 < log_sense_data_end(data, data_len); __tmp+=2, supported_page = __tmp[0], supported_subpage = __tmp[1])

bool log_sense_page_informational_exceptions(uint8_t *page, unsigned page_len, uint8_t *asc, uint8_t *ascq, uint8_t *temperature);

#endif