A modern Music Player Daemon based on Rockbox open source high quality audio player
tsiry-sandratraina.com
libadwaita
audio
rust
zig
deno
mpris
rockbox
mpd
1/***************************************************************************
2 * __________ __ ___.
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
7 * \/ \/ \/ \/ \/
8 * $Id$
9 *
10 * Copyright (C) 2002 by Björn Stenberg
11 *
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation; either version 2
15 * of the License, or (at your option) any later version.
16 *
17 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
18 * KIND, either express or implied.
19 *
20 ****************************************************************************/
21
22#ifndef QUEUE_H
23#define QUEUE_H
24
25#include <stdint.h>
26#include "config.h"
27#include "thread.h"
28
29/* System defined message ID's - |sign bit = 1|class|id| */
30/* Event class list */
31#define SYS_EVENT_CLS_QUEUE 0
32#define SYS_EVENT_CLS_USB 1
33#define SYS_EVENT_CLS_POWER 2
34#define SYS_EVENT_CLS_FILESYS 3
35#define SYS_EVENT_CLS_PLUG 4
36#define SYS_EVENT_CLS_MISC 5
37#define SYS_EVENT_CLS_PRIVATE 7 /* For use inside plugins */
38/* make sure SYS_EVENT_CLS_BITS has enough range */
39
40/* Bit 31->|S|c...c|i...i| */
41#define SYS_EVENT ((long)(int)(1u << 31))
42#define SYS_EVENT_CLS_BITS (3)
43#define SYS_EVENT_CLS_SHIFT (31-SYS_EVENT_CLS_BITS)
44#define SYS_EVENT_CLS_MASK (((1l << SYS_EVENT_CLS_BITS)-1) << SYS_EVENT_SHIFT)
45#define MAKE_SYS_EVENT(cls, id) (SYS_EVENT | ((long)(cls) << SYS_EVENT_CLS_SHIFT) | (long)(id))
46/* Macros for extracting codes */
47#define SYS_EVENT_CLS(e) (((e) & SYS_EVENT_CLS_MASK) >> SYS_EVENT_SHIFT)
48#define SYS_EVENT_ID(e) ((e) & ~(SYS_EVENT|SYS_EVENT_CLS_MASK))
49
50#define SYS_TIMEOUT MAKE_SYS_EVENT(SYS_EVENT_CLS_QUEUE, 0)
51#define SYS_USB_CONNECTED MAKE_SYS_EVENT(SYS_EVENT_CLS_USB, 0)
52#define SYS_USB_CONNECTED_ACK MAKE_SYS_EVENT(SYS_EVENT_CLS_USB, 1)
53#define SYS_USB_DISCONNECTED MAKE_SYS_EVENT(SYS_EVENT_CLS_USB, 2)
54#define SYS_USB_LUN_LOCKED MAKE_SYS_EVENT(SYS_EVENT_CLS_USB, 4)
55#define SYS_USB_READ_DATA MAKE_SYS_EVENT(SYS_EVENT_CLS_USB, 5)
56#define SYS_USB_WRITE_DATA MAKE_SYS_EVENT(SYS_EVENT_CLS_USB, 6)
57#define SYS_POWEROFF MAKE_SYS_EVENT(SYS_EVENT_CLS_POWER, 0)
58#define SYS_CHARGER_CONNECTED MAKE_SYS_EVENT(SYS_EVENT_CLS_POWER, 1)
59#define SYS_CHARGER_DISCONNECTED MAKE_SYS_EVENT(SYS_EVENT_CLS_POWER, 2)
60#define SYS_BATTERY_UPDATE MAKE_SYS_EVENT(SYS_EVENT_CLS_POWER, 3)
61#define SYS_REBOOT MAKE_SYS_EVENT(SYS_EVENT_CLS_POWER, 4)
62#define SYS_FS_CHANGED MAKE_SYS_EVENT(SYS_EVENT_CLS_FILESYS, 0)
63#define SYS_HOTSWAP_INSERTED MAKE_SYS_EVENT(SYS_EVENT_CLS_PLUG, 0)
64#define SYS_HOTSWAP_EXTRACTED MAKE_SYS_EVENT(SYS_EVENT_CLS_PLUG, 1)
65#define SYS_PHONE_PLUGGED MAKE_SYS_EVENT(SYS_EVENT_CLS_PLUG, 2)
66#define SYS_PHONE_UNPLUGGED MAKE_SYS_EVENT(SYS_EVENT_CLS_PLUG, 3)
67#define SYS_REMOTE_PLUGGED MAKE_SYS_EVENT(SYS_EVENT_CLS_PLUG, 4)
68#define SYS_REMOTE_UNPLUGGED MAKE_SYS_EVENT(SYS_EVENT_CLS_PLUG, 5)
69#define SYS_LINEOUT_PLUGGED MAKE_SYS_EVENT(SYS_EVENT_CLS_PLUG, 6)
70#define SYS_LINEOUT_UNPLUGGED MAKE_SYS_EVENT(SYS_EVENT_CLS_PLUG, 7)
71#define SYS_CAR_ADAPTER_RESUME MAKE_SYS_EVENT(SYS_EVENT_CLS_MISC, 0)
72#define SYS_CALL_INCOMING MAKE_SYS_EVENT(SYS_EVENT_CLS_MISC, 3)
73#define SYS_CALL_HUNG_UP MAKE_SYS_EVENT(SYS_EVENT_CLS_MISC, 4)
74#define SYS_VOLUME_CHANGED MAKE_SYS_EVENT(SYS_EVENT_CLS_MISC, 5)
75
76#define IS_SYSEVENT(ev) ((ev & SYS_EVENT) == SYS_EVENT)
77
78#define MAX_NUM_QUEUES 32
79#define QUEUE_LENGTH 16 /* MUST be a power of 2 */
80#define QUEUE_LENGTH_MASK (QUEUE_LENGTH - 1)
81
82struct queue_event
83{
84 long id;
85 intptr_t data;
86};
87
88#ifdef HAVE_EXTENDED_MESSAGING_AND_NAME
89struct queue_sender_list
90{
91 /* If non-NULL, there is a thread waiting for the corresponding event */
92 /* Must be statically allocated to put in non-cached ram. */
93 struct thread_entry *senders[QUEUE_LENGTH]; /* message->thread map */
94 struct __wait_queue list; /* list of senders in map */
95 /* Send info for last message dequeued or NULL if replied or not sent */
96 struct thread_entry * volatile curr_sender;
97#ifdef HAVE_PRIORITY_SCHEDULING
98 struct blocker blocker;
99#endif
100};
101#endif /* HAVE_EXTENDED_MESSAGING_AND_NAME */
102
103#ifdef HAVE_PRIORITY_SCHEDULING
104#define QUEUE_GET_THREAD(q) \
105 (((q)->send == NULL) ? NULL : (q)->send->blocker.thread)
106#else
107/* Queue without priority enabled have no owner provision _at this time_ */
108#define QUEUE_GET_THREAD(q) \
109 (NULL)
110#endif
111
112struct event_queue
113{
114 struct __wait_queue queue; /* waiter list */
115 struct queue_event events[QUEUE_LENGTH]; /* list of events */
116 unsigned int volatile read; /* head of queue */
117 unsigned int volatile write; /* tail of queue */
118#ifdef HAVE_EXTENDED_MESSAGING_AND_NAME
119 struct queue_sender_list * volatile send; /* list of threads waiting for
120 reply to an event */
121#ifdef HAVE_PRIORITY_SCHEDULING
122 struct blocker *blocker_p; /* priority inheritance info
123 for sync message senders */
124#endif
125#endif
126 IF_COP( struct corelock cl; ) /* multiprocessor sync */
127};
128
129extern void queue_init(struct event_queue *q, bool register_queue);
130extern void queue_delete(struct event_queue *q);
131extern void queue_wait(struct event_queue *q, struct queue_event *ev);
132extern void queue_wait_w_tmo(struct event_queue *q, struct queue_event *ev,
133 int ticks);
134extern void queue_post(struct event_queue *q, long id, intptr_t data);
135#ifdef HAVE_EXTENDED_MESSAGING_AND_NAME
136extern void queue_enable_queue_send(struct event_queue *q,
137 struct queue_sender_list *send,
138 unsigned int owner_id);
139extern intptr_t queue_send(struct event_queue *q, long id, intptr_t data);
140extern void queue_reply(struct event_queue *q, intptr_t retval);
141extern bool queue_in_queue_send(struct event_queue *q);
142#endif /* HAVE_EXTENDED_MESSAGING_AND_NAME */
143extern bool queue_empty(const struct event_queue* q);
144extern bool queue_full(const struct event_queue* q);
145extern bool queue_peek(struct event_queue *q, struct queue_event *ev);
146
147#define QPEEK_FILTER_COUNT_MASK (0xffu) /* 0x00=1 filter, 0xff=256 filters */
148#define QPEEK_FILTER_HEAD_ONLY (1u << 8) /* Ignored if no filters */
149#define QPEEK_REMOVE_EVENTS (1u << 9) /* Remove or discard events */
150#define QPEEK_FILTER1(a) QPEEK_FILTER2((a), (a))
151#define QPEEK_FILTER2(a, b) (&(const long [2]){ (a), (b) })
152extern bool queue_peek_ex(struct event_queue *q,
153 struct queue_event *ev,
154 unsigned int flags,
155 const long (*filters)[2]);
156
157extern void queue_clear(struct event_queue* q);
158extern void queue_remove_from_head(struct event_queue *q, long id);
159extern int queue_count(const struct event_queue *q);
160extern int queue_broadcast(long id, intptr_t data);
161extern void init_queues(void);
162
163#endif /* QUEUE_H */