xref: /btstack/src/classic/obex_srm_client.h (revision c44ec4a0413666fda2b79490b2525eeb4855e493)
1 /*
2  * Copyright (C) 2024 BlueKitchen GmbH
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the copyright holders nor the names of
14  *    contributors may be used to endorse or promote products derived
15  *    from this software without specific prior written permission.
16  * 4. Any redistribution, use, or modification is done solely for
17  *    personal benefit and not for any commercial purpose or for
18  *    monetary gain.
19  *
20  * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN
24  * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
27  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
30  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * Please inquire about commercial licensing options at
34  * [email protected]
35  *
36  */
37 
38 #ifndef OBEX_SRM_CLIENT_H
39 #define OBEX_SRM_CLIENT_H
40 
41 #include <stdint.h>
42 
43 #if defined __cplusplus
44 extern "C" {
45 #endif
46 
47 typedef enum {
48     OBEX_SRM_CLIENT_STATE_DISABLED,
49     OBEX_SRM_CLIENT_STATE_W4_CONFIRM,
50     OBEX_SRM_CLIENT_STATE_ENABLED_BUT_WAITING,
51     OBEX_SRM_CLIENT_STATE_ENABLED
52 } obex_srm_client_state_t;
53 
54 typedef struct {
55     obex_srm_client_state_t srm_state;
56 
57     uint8_t srm_value;
58     uint8_t srmp_value;
59 } obex_srm_client_t;
60 
61 /**
62  * Init SRM state
63  * @param obex_srm
64  */
65 void obex_srm_client_init(obex_srm_client_t * obex_srm);
66 
67 /**
68  * Update SRM state based on SRM headers
69  * @param obex_srm
70  */
71 void obex_srm_client_handle_headers(obex_srm_client_t *obex_srm);
72 
73 /**
74  * Add SRM headers if
75  * @param obex_srm
76  * @param goep_cid
77  */
78 void obex_srm_client_prepare_header(obex_srm_client_t *obex_srm, uint16_t goep_cid);
79 
80 #if defined __cplusplus
81 }
82 #endif
83 
84 #endif
85