summaryrefslogtreecommitdiff
path: root/backend/genesys/command_set.h
blob: b031a8cb90b5f3cd1567aa62f5d9c82e48f08029 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
/* sane - Scanner Access Now Easy.

   Copyright (C) 2019 Povilas Kanapickas <povilas@radix.lt>

   This file is part of the SANE package.

   This program is free software; you can redistribute it and/or
   modify it under the terms of the GNU General Public License as
   published by the Free Software Foundation; either version 2 of the
   License, or (at your option) any later version.

   This program is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <https://www.gnu.org/licenses/>.
*/

#ifndef BACKEND_GENESYS_COMMAND_SET_H
#define BACKEND_GENESYS_COMMAND_SET_H

#include "device.h"
#include "fwd.h"
#include <cstdint>

namespace genesys {


/** Scanner command set description.

    This description contains parts which are common to all scanners with the
    same command set, but may have different optical resolution and other
    parameters.
 */
class CommandSet
{
public:
    virtual ~CommandSet() = default;

    virtual bool needs_home_before_init_regs_for_scan(Genesys_Device* dev) const = 0;

    virtual void init(Genesys_Device* dev) const = 0;

    virtual void init_regs_for_warmup(Genesys_Device* dev, const Genesys_Sensor& sensor,
                                      Genesys_Register_Set* regs) const = 0;

    virtual void init_regs_for_shading(Genesys_Device* dev, const Genesys_Sensor& sensor,
                                       Genesys_Register_Set& regs) const = 0;

    /** Set up registers for a scan. Similar to init_regs_for_scan except that the session is
        already computed from the session
    */
    virtual void init_regs_for_scan_session(Genesys_Device* dev, const Genesys_Sensor& sensor,
                                            Genesys_Register_Set* reg,
                                            const ScanSession& session) const= 0;

    virtual void set_fe(Genesys_Device* dev, const Genesys_Sensor& sensor, std::uint8_t set) const = 0;
    virtual void set_powersaving(Genesys_Device* dev, int delay) const = 0;
    virtual void save_power(Genesys_Device* dev, bool enable) const = 0;

    virtual void begin_scan(Genesys_Device* dev, const Genesys_Sensor& sensor,
                            Genesys_Register_Set* regs, bool start_motor) const = 0;
    virtual void end_scan(Genesys_Device* dev, Genesys_Register_Set* regs,
                          bool check_stop) const = 0;


    /**
     * Send gamma tables to ASIC
     */
    virtual void send_gamma_table(Genesys_Device* dev, const Genesys_Sensor& sensor) const = 0;

    virtual void offset_calibration(Genesys_Device* dev, const Genesys_Sensor& sensor,
                                    Genesys_Register_Set& regs) const = 0;
    virtual void coarse_gain_calibration(Genesys_Device* dev, const Genesys_Sensor& sensor,
                                         Genesys_Register_Set& regs, int dpi) const = 0;
    virtual SensorExposure led_calibration(Genesys_Device* dev, const Genesys_Sensor& sensor,
                                           Genesys_Register_Set& regs) const = 0;

    virtual void wait_for_motor_stop(Genesys_Device* dev) const = 0;
    virtual void move_back_home(Genesys_Device* dev, bool wait_until_home) const = 0;

    // Updates hardware sensor information in Genesys_Scanner.val[].
    virtual void update_hardware_sensors(struct Genesys_Scanner* s) const = 0;

    /** Needed on some chipsets before reading the status of the home sensor as the sensor may be
        controlled by additional GPIO registers.
    */
    virtual void update_home_sensor_gpio(Genesys_Device& dev) const = 0;

    // functions for sheetfed scanners

    // load document into scanner
    virtual void load_document(Genesys_Device* dev) const = 0;

    /** Detects is the scanned document has left scanner. In this case it updates the amount of
        data to read and set up flags in the dev struct
     */
    virtual void detect_document_end(Genesys_Device* dev) const = 0;

    /// eject document from scanner
    virtual void eject_document(Genesys_Device* dev) const = 0;

    /// write shading data calibration to ASIC
    virtual void send_shading_data(Genesys_Device* dev, const Genesys_Sensor& sensor,
                                   std::uint8_t* data, int size) const = 0;

    virtual bool has_send_shading_data() const
    {
        return true;
    }

    /// calculate an instance of ScanSession for scanning with the given settings
    virtual ScanSession calculate_scan_session(const Genesys_Device* dev,
                                               const Genesys_Sensor& sensor,
                                               const Genesys_Settings& settings) const = 0;

    /// cold boot init function
    virtual void asic_boot(Genesys_Device* dev, bool cold) const = 0;

    /// checks if specific scan head is at home position
    virtual bool is_head_home(Genesys_Device& dev, ScanHeadId scan_head) const = 0;

    /// enables or disables XPA slider motor
    virtual void set_xpa_lamp_power(Genesys_Device& dev, bool set) const = 0;

    /// enables or disables XPA slider motor
    virtual void set_motor_mode(Genesys_Device& dev, Genesys_Register_Set& regs,
                                MotorMode mode) const = 0;
};

} // namespace genesys

#endif // BACKEND_GENESYS_COMMAND_SET_H