root/trunk/libffado/src/dice/dice_eap.h

Revision 2056, 18.9 kB (checked in by adi, 11 years ago)

DICE EAP

Implements EAP::Mixer::getRowName and EAP::getColName

Line 
1 /*
2  * Copyright (C) 2005-2009 by Pieter Palmers
3  *
4  * This file is part of FFADO
5  * FFADO = Free Firewire (pro-)audio drivers for linux
6  *
7  * FFADO is based upon FreeBoB
8  *
9  * This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation, either version 2 of the License, or
12  * (at your option) version 3 of the License.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
21  *
22  */
23 #ifndef __DICE_EAP_H
24 #define __DICE_EAP_H
25
26 #include "dice_avdevice.h"
27
28 #define DICE_EAP_BASE                  0x0000000000200000ULL
29 #define DICE_EAP_MAX_SIZE              0x0000000000F00000ULL
30
31 #define DICE_EAP_CAPABILITY_SPACE_OFF      0x0000
32 #define DICE_EAP_CAPABILITY_SPACE_SZ       0x0004
33 #define DICE_EAP_CMD_SPACE_OFF             0x0008
34 #define DICE_EAP_CMD_SPACE_SZ              0x000C
35 #define DICE_EAP_MIXER_SPACE_OFF           0x0010
36 #define DICE_EAP_MIXER_SPACE_SZ            0x0014
37 #define DICE_EAP_PEAK_SPACE_OFF            0x0018
38 #define DICE_EAP_PEAK_SPACE_SZ             0x001C
39 #define DICE_EAP_NEW_ROUTING_SPACE_OFF     0x0020
40 #define DICE_EAP_NEW_ROUTING_SPACE_SZ      0x0024
41 #define DICE_EAP_NEW_STREAM_CFG_SPACE_OFF  0x0028
42 #define DICE_EAP_NEW_STREAM_CFG_SPACE_SZ   0x002C
43 #define DICE_EAP_CURR_CFG_SPACE_OFF        0x0030
44 #define DICE_EAP_CURR_CFG_SPACE_SZ         0x0034
45 #define DICE_EAP_STAND_ALONE_CFG_SPACE_OFF 0x0038
46 #define DICE_EAP_STAND_ALONE_CFG_SPACE_SZ  0x003C
47 #define DICE_EAP_APP_SPACE_OFF             0x0040
48 #define DICE_EAP_APP_SPACE_SZ              0x0044
49 #define DICE_EAP_ZERO_MARKER_1             0x0048
50
51 // CAPABILITY registers
52 #define DICE_EAP_CAPABILITY_ROUTER         0x0000
53 #define DICE_EAP_CAPABILITY_MIXER          0x0004
54 #define DICE_EAP_CAPABILITY_GENERAL        0x0008
55 #define DICE_EAP_CAPABILITY_RESERVED       0x000C
56
57 // CAPABILITY bit definitions
58 #define DICE_EAP_CAP_ROUTER_EXPOSED         0
59 #define DICE_EAP_CAP_ROUTER_READONLY        1
60 #define DICE_EAP_CAP_ROUTER_FLASHSTORED     2
61 #define DICE_EAP_CAP_ROUTER_MAXROUTES      16
62
63 #define DICE_EAP_CAP_MIXER_EXPOSED          0
64 #define DICE_EAP_CAP_MIXER_READONLY         1
65 #define DICE_EAP_CAP_MIXER_FLASHSTORED      2
66 #define DICE_EAP_CAP_MIXER_IN_DEV           4
67 #define DICE_EAP_CAP_MIXER_OUT_DEV          8
68 #define DICE_EAP_CAP_MIXER_INPUTS          16
69 #define DICE_EAP_CAP_MIXER_OUTPUTS         24
70
71 #define DICE_EAP_CAP_GENERAL_STRM_CFG_EN    0
72 #define DICE_EAP_CAP_GENERAL_FLASH_EN       1
73 #define DICE_EAP_CAP_GENERAL_PEAK_EN        2
74 #define DICE_EAP_CAP_GENERAL_MAX_TX_STREAM  4
75 #define DICE_EAP_CAP_GENERAL_MAX_RX_STREAM  8
76 #define DICE_EAP_CAP_GENERAL_STRM_CFG_FLS  12
77 #define DICE_EAP_CAP_GENERAL_CHIP          16
78
79 #define DICE_EAP_CAP_GENERAL_CHIP_DICEII    0
80 #define DICE_EAP_CAP_GENERAL_CHIP_DICEMINI  1
81 #define DICE_EAP_CAP_GENERAL_CHIP_DICEJR    2
82
83 // COMMAND registers
84 #define DICE_EAP_COMMAND_OPCODE         0x0000
85 #define DICE_EAP_COMMAND_RETVAL         0x0004
86
87 // opcodes
88 #define DICE_EAP_CMD_OPCODE_NO_OP            0x0000
89 #define DICE_EAP_CMD_OPCODE_LD_ROUTER        0x0001
90 #define DICE_EAP_CMD_OPCODE_LD_STRM_CFG      0x0002
91 #define DICE_EAP_CMD_OPCODE_LD_RTR_STRM_CFG  0x0003
92 #define DICE_EAP_CMD_OPCODE_LD_FLASH_CFG     0x0004
93 #define DICE_EAP_CMD_OPCODE_ST_FLASH_CFG     0x0005
94
95 #define DICE_EAP_CMD_OPCODE_FLAG_LD_LOW      (1U<<16)
96 #define DICE_EAP_CMD_OPCODE_FLAG_LD_MID      (1U<<17)
97 #define DICE_EAP_CMD_OPCODE_FLAG_LD_HIGH     (1U<<18)
98 #define DICE_EAP_CMD_OPCODE_FLAG_LD_EXECUTE  (1U<<31)
99
100
101 // MIXER registers
102 // TODO
103
104 // PEAK registers
105 // TODO
106
107 // NEW ROUTER registers
108 // TODO
109
110 // NEW STREAM CFG registers
111 // TODO
112
113 // CURRENT CFG registers
114 #define DICE_EAP_CURRCFG_LOW_ROUTER         0x0000
115 #define DICE_EAP_CURRCFG_LOW_STREAM         0x1000
116 #define DICE_EAP_CURRCFG_MID_ROUTER         0x2000
117 #define DICE_EAP_CURRCFG_MID_STREAM         0x3000
118 #define DICE_EAP_CURRCFG_HIGH_ROUTER        0x4000
119 #define DICE_EAP_CURRCFG_HIGH_STREAM        0x5000
120
121 #define DICE_EAP_CHANNEL_CONFIG_NAMESTR_LEN_QUADS  (64)
122 #define DICE_EAP_CHANNEL_CONFIG_NAMESTR_LEN_BYTES  (4*DICE_EAP_CHANNEL_CONFIG_NAMESTR_LEN_QUADS)
123
124 namespace Dice {
125
126 /**
127   @brief Sources for audio hitting the router
128   */
129 enum eRouteSource {
130     eRS_AES = 0,
131     eRS_ADAT = 1,
132     eRS_Mixer = 2,
133     eRS_InS0 = 4,
134     eRS_InS1 = 5,
135     eRS_ARM = 10,
136     eRS_ARX0 = 11,
137     eRS_ARX1 = 12,
138     eRS_Muted = 15,
139     eRS_Invalid = 16,
140 };
141 /**
142   @brief Destinations for audio exiting the router
143   */
144 enum eRouteDestination {
145     eRD_AES = 0,
146     eRD_ADAT = 1,
147     eRD_Mixer0 = 2,
148     eRD_Mixer1 = 3,
149     eRD_InS0 = 4,
150     eRD_InS1 = 5,
151     eRD_ARM = 10,
152     eRD_ATX0 = 11,
153     eRD_ATX1 = 12,
154     eRD_Muted = 15,
155     eRD_Invalid = 16,
156 };
157
158 /**
159   @brief represents the EAP interface available on some devices
160
161   When available, the mixer and router are visible. This class is also the base for custom
162   implementations of EAP extensions.
163   */
164 class EAP : public Control::Container
165 {
166 public:
167     /**
168       @brief Command status
169       */
170     enum eWaitReturn {
171         eWR_Error,
172         eWR_Timeout,
173         eWR_Busy,
174         eWR_Done,
175     };
176     /**
177       @brief Constants for the EAP spaces
178
179       @see offsetGen for the calculation of the real offsets.
180       */
181     enum eRegBase {
182         eRT_Base,
183         eRT_Capability,
184         eRT_Command,
185         eRT_Mixer,
186         eRT_Peak,
187         eRT_NewRouting,
188         eRT_NewStreamCfg,
189         eRT_CurrentCfg,
190         eRT_Standalone,
191         eRT_Application,
192         eRT_None,
193     };
194
195 private:
196
197     /**
198       @brief Description of the routing in the hardware
199       */
200     class RouterConfig {
201     private:
202         friend class Dice::EAP;
203         RouterConfig(EAP &);
204         RouterConfig(EAP &, enum eRegBase, unsigned int offset);
205         ~RouterConfig();
206
207     public:
208
209         bool read() {return read(m_base, m_offset);};
210         bool write() {return write(m_base, m_offset);};
211         bool read(enum eRegBase b, unsigned offset);
212         bool write(enum eRegBase b, unsigned offset);
213         void show();
214
215         /**
216           @brief Set up a route between src and dest
217
218           If a route with that destination exists, it will be replaced. If no route to that
219           destination exists, a new route will be established.
220           */
221         bool setupRoute(unsigned char src, unsigned char dest);
222         /**
223           @brief Remove a route
224
225           @todo is this really necessary?
226           */
227         bool removeRoute(unsigned char src, unsigned char dest);
228         /**
229           @brief Remove the destinations route
230           */
231         bool removeRoute(unsigned char dest);
232
233         /**
234           @brief Return the source for the given destination
235
236           Returns -1 if the destination is not connected.
237           */
238         unsigned char getSourceForDestination(unsigned char dest);
239         /**
240           @brief Return a list of destinations for a given source
241
242           Returns an empty list if no destination is connected to this source.
243           */
244         std::vector<unsigned char> getDestinationsForSource(unsigned char src);
245
246         unsigned int getNbRoutes() {return m_routes2.size();};
247
248     private:
249         EAP &m_eap;
250         enum eRegBase m_base;
251         unsigned int m_offset;
252
253         /**
254           @brief map for the routes
255
256           The key is the destination as each destination can only have audio from one source.
257           Sources can be routed to several destinations though.
258           */
259         typedef std::map<unsigned char,unsigned char> RouteVectorV2;
260         RouteVectorV2 m_routes2;
261     private:
262         DECLARE_DEBUG_MODULE_REFERENCE;
263     };
264
265     /**
266       @brief Description of the peak space in hardware
267       */
268     class PeakSpace {
269     private:
270         friend class Dice::EAP;
271         PeakSpace(EAP &p) : m_eap(p), m_base(eRT_Peak), m_offset(0), m_debugModule(p.m_debugModule) {};
272         ~PeakSpace() {};
273
274     public:
275         bool read() {return read(m_base, m_offset);};
276         bool read(enum eRegBase b, unsigned offset);
277         void show();
278
279         std::map<unsigned char, int> getPeaks();
280         int getPeak(unsigned char dest);
281
282     private:
283         EAP &m_eap;
284         enum eRegBase m_base;
285         unsigned int m_offset;
286
287         /**
288           @brief maps peaks to destinations
289           */
290         std::map<unsigned char, int> m_peaks;
291
292         DECLARE_DEBUG_MODULE_REFERENCE;
293     };
294
295     /**
296       @brief Description of the streams in the hardware
297       */
298     class StreamConfig {
299     private:
300         friend class Dice::EAP;
301         StreamConfig(EAP &, enum eRegBase, unsigned int offset);
302         ~StreamConfig();
303
304     public:
305         struct ConfigBlock { // FIXME: somewhere in the DICE avdevice this is present too
306             uint32_t nb_audio;
307             uint32_t nb_midi;
308             uint32_t names[DICE_EAP_CHANNEL_CONFIG_NAMESTR_LEN_QUADS];
309             uint32_t ac3_map;
310         };
311         void showConfigBlock(struct ConfigBlock &);
312         stringlist getNamesForBlock(struct ConfigBlock &b);
313
314         bool read() {return read(m_base, m_offset);};
315         bool write() {return write(m_base, m_offset);};
316         bool read(enum eRegBase b, unsigned offset);
317         bool write(enum eRegBase b, unsigned offset);
318
319         void show();
320
321     private:
322         EAP &m_eap;
323         enum eRegBase m_base;
324         unsigned int m_offset;
325
326         uint32_t m_nb_tx;
327         uint32_t m_nb_rx;
328
329         struct ConfigBlock *m_tx_configs;
330         struct ConfigBlock *m_rx_configs;
331
332         DECLARE_DEBUG_MODULE_REFERENCE;
333     };
334
335 public:
336
337     /**
338       @brief The matrixmixer exposed
339       */
340     class Mixer : public Control::MatrixMixer {
341     public:
342         Mixer(EAP &);
343         ~Mixer();
344
345         bool init();
346         void show();
347
348         void updateNameCache();
349         /**
350          * load the coefficients from the device into the local cache
351          * @return
352          */
353         bool loadCoefficients();
354         /**
355          * Stores the coefficients from the cache to the device
356          * @return
357          */
358         bool storeCoefficients();
359
360         virtual int getRowCount( );
361         virtual int getColCount( );
362
363         virtual int canWrite( const int, const int );
364         virtual double setValue( const int, const int, const double );
365         virtual double getValue( const int, const int );
366
367         //
368         bool hasNames() const { return false; }
369         std::string getRowName( const int );
370         std::string getColName( const int );
371
372         // TODO: implement connections.
373         bool canConnect() const { return false; }
374
375         // full map updates are unsupported
376         virtual bool getCoefficientMap(int &);
377         virtual bool storeCoefficientMap(int &);
378
379     private:
380         EAP &         m_eap;
381         fb_quadlet_t *m_coeff;
382
383         //std::map<int, RouterConfig::Route> m_input_route_map;
384         //std::map<int, RouterConfig::RouteVector> m_output_route_map;
385
386         DECLARE_DEBUG_MODULE_REFERENCE;
387     };
388
389     /**
390       @brief The router exposed
391       */
392     class Router : public Control::CrossbarRouter {
393     public:
394         Router(EAP &);
395         ~Router();
396
397         void update();
398         void show();
399
400         void addDestination(const std::string& name, enum eRouteDestination dstid,
401                             unsigned int base, unsigned int cnt, unsigned int offset=0);
402         void addSource(const std::string& name, enum eRouteSource srcid,
403                        unsigned int base, unsigned int cnt, unsigned int offset=0);
404
405         // per-coefficient access
406         virtual std::string getSourceName(const int);
407         virtual std::string getDestinationName(const int);
408         virtual int getSourceIndex(std::string);
409         virtual int getDestinationIndex(std::string);
410         virtual stringlist getSourceNames();
411         virtual stringlist getDestinationNames();
412
413         std::string getSourceForDestination(const std::string& dstname);
414         stringlist getDestinationsForSource(const std::string& srcname);
415
416         virtual bool canConnect(const int srcidx, const int dstidx);
417         virtual bool setConnectionState(const int srcidx, const int dstidx, const bool enable);
418         virtual bool getConnectionState(const int srcidx, const int dstidx);
419
420         virtual bool canConnect(const std::string& srcname, const std::string& dstname);
421         virtual bool setConnectionState(const std::string& srcname, const std::string& dstname, const bool enable);
422         virtual bool getConnectionState(const std::string& srcname, const std::string& dstname);
423
424         virtual bool clearAllConnections();
425
426         // peak metering support
427         virtual bool hasPeakMetering();
428         virtual double getPeakValue(const std::string& dest);
429         virtual std::map<std::string, double> getPeakValues();
430
431     private:
432         EAP &m_eap;
433         /**
434           @{
435           @brief Name-Index pairs for the sources and destinations
436
437           The index is 'artificial' and is the block/channel combination used in the dice.
438           */
439         std::map<std::string, int> m_sources;
440         std::map<std::string, int> m_destinations;
441         // @}
442
443         PeakSpace &m_peak;
444
445         DECLARE_DEBUG_MODULE_REFERENCE;
446     };
447
448 public:
449     /** constructor */
450     EAP(Device &);
451     /** destructor */
452     virtual ~EAP();
453
454     /**
455       @brief Does this device support the EAP?
456
457       When subclassing EAP, return true only on devices that actually have an EAP.
458
459       @todo Shouldn't this be inside Dice::Device?
460       */
461     static bool supportsEAP(Device &);
462
463     /**
464       @brief Initialize the EAP
465       */
466     bool init();
467
468     /// update EAP
469     void update();
470
471     /// Show information about the EAP
472     void show();
473     /// Dump the first parts of the application space
474     void showApplication();
475
476     /// Restore from flash
477     bool loadFlashConfig();
478     /// Store to flash
479     bool storeFlashConfig();
480
481     /// Is the current operation still busy?
482     enum eWaitReturn operationBusy();
483     /// Block until the current operation is done
484     enum eWaitReturn waitForOperationEnd(int max_wait_time_ms = 100);
485
486     /// Update all configurations from the device
487     bool updateConfigurationCache();
488
489     /**
490       @{
491       @brief Read and write registers on the device
492       */
493     bool readReg(enum eRegBase, unsigned offset, quadlet_t *);
494     bool writeReg(enum eRegBase, unsigned offset, quadlet_t);
495     bool readRegBlock(enum eRegBase, unsigned, fb_quadlet_t *, size_t);
496     bool writeRegBlock(enum eRegBase, unsigned, fb_quadlet_t *, size_t);
497     bool readRegBlockSwapped(enum eRegBase, unsigned, fb_quadlet_t *, size_t);
498     bool writeRegBlockSwapped(enum eRegBase, unsigned, fb_quadlet_t *, size_t);
499     //@}
500
501     /** @brief Get access to the mixer */
502     Mixer*  getMixer() {return m_mixer;};
503     /** @brief Get access to the router */
504     Router* getRouter() {return m_router;};
505
506 protected:
507     /**
508       @brief Setup all the available sources
509
510       This adds the needed entries for sources to the router. The default implementation decides on
511       the chip which sources to add, subclasses should only add the sources actually usable for the
512       device.
513
514       To ease custom device support, this function is not in EAP::Router but here.
515       */
516     void setupSources();
517     virtual void setupSources_low();
518     virtual void setupSources_mid();
519     virtual void setupSources_high();
520     /**
521       @brief Setup all the available destinations
522
523       This adds the needed entries for destinations to the router. The default implementation
524       decides on the chip which destinations to add, subclasses should only add the destinations
525       actually usable for the device.
526
527       To ease custom device support, this function is not in EAP::Router but here.
528       */
529     void setupDestinations();
530     virtual void setupDestinations_low();
531     virtual void setupDestinations_mid();
532     virtual void setupDestinations_high();
533
534     /**
535       @brief Actually add the source
536       */
537     void addSource(const std::string name, unsigned int base, unsigned int count,
538                    enum eRouteSource srcid, unsigned int offset=0);
539     /**
540       @brief Actually add the destination
541       */
542     void addDestination(const std::string name, unsigned int base, unsigned int count,
543                         enum eRouteDestination destid, unsigned int offset=0);
544
545 private:
546     /// Return the router configuration for the current rate
547     RouterConfig * getActiveRouterConfig();
548     /// Return the stream configuration for the current rate
549     StreamConfig * getActiveStreamConfig();
550
551     /// Write a new router configuration to the device
552     bool updateRouterConfig(RouterConfig&, bool low, bool mid, bool high);
553     /// Write a new router configuration to the device
554     bool updateCurrentRouterConfig(RouterConfig&);
555     /// Write a new stream configuration to the device
556     bool updateStreamConfig(StreamConfig&, bool low, bool mid, bool high);
557     /// Write a new stream configuration to the device
558     bool updateStreamConfig(RouterConfig&, StreamConfig&, bool low, bool mid, bool high);
559
560     bool loadRouterConfig(bool low, bool mid, bool high);
561     bool loadStreamConfig(bool low, bool mid, bool high);
562     bool loadRouterAndStreamConfig(bool low, bool mid, bool high);
563
564 private:
565     bool     m_router_exposed;
566     bool     m_router_readonly;
567     bool     m_router_flashstored;
568     uint16_t m_router_nb_entries;
569
570     bool     m_mixer_exposed;
571     bool     m_mixer_readonly;
572     bool     m_mixer_flashstored;
573     uint8_t  m_mixer_tx_id;
574     uint8_t  m_mixer_rx_id;
575     uint8_t  m_mixer_nb_tx;
576     uint8_t  m_mixer_nb_rx;
577
578     bool     m_general_support_dynstream;
579     bool     m_general_support_flash;
580     bool     m_general_peak_enabled;
581     uint8_t  m_general_max_tx;
582     uint8_t  m_general_max_rx;
583     bool     m_general_stream_cfg_stored;
584     uint16_t m_general_chip;
585
586     bool commandHelper(fb_quadlet_t cmd);
587
588     /// Calculate the real offset for the different spaces
589     fb_nodeaddr_t offsetGen(enum eRegBase, unsigned, size_t);
590
591 private:
592     Device & m_device;
593     Mixer*   m_mixer;
594     Router*  m_router;
595     RouterConfig m_current_cfg_routing_low;
596     RouterConfig m_current_cfg_routing_mid;
597     RouterConfig m_current_cfg_routing_high;
598     StreamConfig m_current_cfg_stream_low;
599     StreamConfig m_current_cfg_stream_mid;
600     StreamConfig m_current_cfg_stream_high;
601
602     fb_quadlet_t m_capability_offset;
603     fb_quadlet_t m_capability_size;
604     fb_quadlet_t m_cmd_offset;
605     fb_quadlet_t m_cmd_size;
606     fb_quadlet_t m_mixer_offset;
607     fb_quadlet_t m_mixer_size;
608     fb_quadlet_t m_peak_offset;
609     fb_quadlet_t m_peak_size;
610     fb_quadlet_t m_new_routing_offset;
611     fb_quadlet_t m_new_routing_size;
612     fb_quadlet_t m_new_stream_cfg_offset;
613     fb_quadlet_t m_new_stream_cfg_size;
614     fb_quadlet_t m_curr_cfg_offset;
615     fb_quadlet_t m_curr_cfg_size;
616     fb_quadlet_t m_standalone_offset;
617     fb_quadlet_t m_standalone_size;
618     fb_quadlet_t m_app_offset;
619     fb_quadlet_t m_app_size;
620
621 protected:
622     DECLARE_DEBUG_MODULE;
623 };
624
625 };
626
627 #endif // __DICE_EAP_H
Note: See TracBrowser for help on using the browser.