• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2013 - Mauro Carvalho Chehab <mchehab@kernel.org>
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License as published by
6  * the Free Software Foundation version 2.1 of the License.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11  * GNU Lesser General Public License for more details.
12  *
13  * You should have received a copy of the GNU Lesser General Public License
14  * along with this program; if not, write to the Free Software
15  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16  * Or, point your browser to http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
17  *
18  * Described on IEC/CENELEC DS/EN 62216-1:2011
19  *
20  * I couldn't find the original version, so I used what's there at:
21  *	http://tdt.telecom.pt/recursos/apresentacoes/Signalling Specifications for DTT deployment in Portugal.pdf
22  */
23 
24 /**
25  * @file desc_partial_reception.h
26  * @ingroup descriptors
27  * @brief Provides the descriptors for the ISDB partial reception descriptor
28  * @copyright GNU Lesser General Public License version 2.1 (LGPLv2.1)
29  * @author Mauro Carvalho Chehab
30  * @author Andre Roth
31  *
32  * @par Relevant specs
33  * The descriptor described herein is defined at:
34  * - IEC/CENELEC DS/EN 62216-1:2011
35  *
36  * @see http://tdt.telecom.pt/recursos/apresentacoes/Signalling Specifications for DTT deployment in Portugal.pdf
37  *
38  * @par Bug Report
39  * Please submit bug reports and patches to linux-media@vger.kernel.org
40  */
41 
42 
43 #ifndef _PARTIAL_RECEPTION_H
44 #define _PARTIAL_RECEPTION_H
45 
46 #include <libdvbv5/descriptors.h>
47 
48 /**
49  * @struct isdb_partial_reception_service_id
50  * @ingroup descriptors
51  * @brief Service ID that uses partial reception
52  *
53  * @param service_id	service id
54  */
55 struct isdb_partial_reception_service_id {
56 	uint16_t service_id;
57 } __attribute__((packed));
58 
59 /**
60  * @struct isdb_desc_partial_reception
61  * @ingroup descriptors
62  * @brief Structure containing the partial reception descriptor
63  *
64  * @param type			descriptor tag
65  * @param length		descriptor length
66  * @param next			pointer to struct dvb_desc
67  * @param partial_reception	vector of struct isdb_partial_reception_service_id.
68  *				The length of the vector is given by:
69  *				length / sizeof(struct isdb_partial_reception_service_id).
70  */
71 struct isdb_desc_partial_reception {
72 	uint8_t type;
73 	uint8_t length;
74 	struct dvb_desc *next;
75 
76 	struct isdb_partial_reception_service_id *partial_reception;
77 } __attribute__((packed));
78 
79 struct dvb_v5_fe_parms;
80 
81 #ifdef __cplusplus
82 extern "C" {
83 #endif
84 
85 /**
86  * @brief Initializes and parses the ISDB-T partial reception descriptor
87  * @ingroup descriptors
88  *
89  * @param parms	struct dvb_v5_fe_parms pointer to the opened device
90  * @param buf	buffer containing the descriptor's raw data
91  * @param desc	pointer to struct dvb_desc to be allocated and filled
92  *
93  * This function allocates a the descriptor and fills the fields inside
94  * the struct. It also makes sure that all fields will follow the CPU
95  * endianness. Due to that, the content of the buffer may change.
96  *
97  * @return On success, it returns the size of the allocated struct.
98  *	   A negative value indicates an error.
99  */
100 int isdb_desc_partial_reception_init(struct dvb_v5_fe_parms *parms,
101 				     const uint8_t *buf, struct dvb_desc *desc);
102 
103 /**
104  * @brief Prints the content of the ISDB-T partial reception descriptor
105  * @ingroup descriptors
106  *
107  * @param parms	struct dvb_v5_fe_parms pointer to the opened device
108  * @param desc	pointer to struct dvb_desc
109  */
110 void isdb_desc_partial_reception_print(struct dvb_v5_fe_parms *parms,
111 				       const struct dvb_desc *desc);
112 
113 /**
114  * @brief Frees all data allocated by the ISDB-T partial reception descriptor
115  * @ingroup descriptors
116  *
117  * @param desc pointer to struct dvb_desc to be freed
118  */
119 void isdb_desc_partial_reception_free(struct dvb_desc *desc);
120 
121 #ifdef __cplusplus
122 }
123 #endif
124 
125 #endif
126