1 /*
2  * Copyright (c) 2011-2014 - Mauro Carvalho Chehab
3  * Copyright (c) 2012 - Andre Roth <neolynx@gmail.com>
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU Lesser General Public License as published by
7  * the Free Software Foundation version 2.1 of the License.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  * Or, point your browser to http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
18  *
19  */
20 
21 #ifndef _DESC_FREQUENCY_LIST_H
22 #define _DESC_FREQUENCY_LIST_H
23 
24 #include <libdvbv5/descriptors.h>
25 /**
26  * @file desc_frequency_list.h
27  * @ingroup descriptors
28  * @brief Provides the descriptors for the frequency list descriptor.
29  *	  This descriptor lists the additional frequencies used in transmission
30  *	  of a multiplex on other frequencies.
31  * @copyright GNU Lesser General Public License version 2.1 (LGPLv2.1)
32  * @author Mauro Carvalho Chehab
33  * @author Andre Roth
34  *
35  * @par Relevant specs
36  * The descriptor described herein is defined at:
37  * - ETSI EN 300 468 V1.11.1
38  *
39  * @par Bug Report
40  * Please submit bug reports and patches to linux-media@vger.kernel.org
41  */
42 
43 /**
44  * @struct dvb_desc_frequency_list
45  * @ingroup descriptors
46  * @brief Struct containing the frequency list descriptor
47  *
48  * @param type			descriptor tag
49  * @param length		descriptor length
50  * @param next			pointer to struct dvb_desc
51  * @param frequencies		number of frequencies in the frequency vector
52  * @param frequency		vector with the centre frequency
53  * @param freq_type		freq type, being: 0 = undefined,
54  * 				1 = satelite, 2 = cable or 3 = terrestrial.
55  */
56 struct dvb_desc_frequency_list {
57 	uint8_t type;
58 	uint8_t length;
59 	struct dvb_desc *next;
60 
61 	uint8_t frequencies;
62 	uint32_t *frequency;
63 
64 	union {
65 		uint8_t bitfield;
66 		struct {
67 			uint8_t freq_type:2;
68 			uint8_t reserved:6;
69 		} __attribute__((packed));
70 	} __attribute__((packed));
71 } __attribute__((packed));
72 
73 struct dvb_v5_fe_parms;
74 
75 #ifdef __cplusplus
76 extern "C" {
77 #endif
78 
79 /**
80  * @brief Initializes and parses the frequency list descriptor
81  * @ingroup descriptors
82  *
83  * @param parms	struct dvb_v5_fe_parms pointer to the opened device
84  * @param buf	buffer containing the descriptor's raw data
85  * @param desc	pointer to struct dvb_desc to be allocated and filled
86  *
87  * This function initializes and makes sure that all fields will follow the CPU
88  * endianness. Due to that, the content of the buffer may change.
89  *
90  * Currently, no memory is allocated internally.
91  *
92  * @return On success, it returns the size of the allocated struct.
93  *	   A negative value indicates an error.
94  */
95 int dvb_desc_frequency_list_init(struct dvb_v5_fe_parms *parms,
96 				 const uint8_t *buf, struct dvb_desc *desc);
97 
98 /**
99  * @brief Prints the content of the frequency list descriptor
100  * @ingroup descriptors
101  *
102  * @param parms	struct dvb_v5_fe_parms pointer to the opened device
103  * @param desc	pointer to struct dvb_desc
104  */
105 void dvb_desc_frequency_list_print(struct dvb_v5_fe_parms *parms,
106 				   const struct dvb_desc *desc);
107 
108 #ifdef __cplusplus
109 }
110 #endif
111 
112 #endif
113