summaryrefslogtreecommitdiff
path: root/backend/genesys/command_set.h
diff options
context:
space:
mode:
authorJörg Frings-Fürst <debian@jff-webhosting.net>2020-02-02 17:14:32 +0100
committerJörg Frings-Fürst <debian@jff-webhosting.net>2020-02-02 17:14:32 +0100
commit5dadc28ea784db1ba1f56c2ea8618d2db67af1c8 (patch)
tree808b2499b54563b3290f34d70d159b1024310873 /backend/genesys/command_set.h
parent5bb4cf12855ec0151de15d6c5a2354ff08766957 (diff)
parent3dade5db2a37543f19f0967901d8d80a52a1e459 (diff)
Merge branch 'feature/upstream' into develop
Diffstat (limited to 'backend/genesys/command_set.h')
-rw-r--r--backend/genesys/command_set.h166
1 files changed, 166 insertions, 0 deletions
diff --git a/backend/genesys/command_set.h b/backend/genesys/command_set.h
new file mode 100644
index 0000000..ab3a4b6
--- /dev/null
+++ b/backend/genesys/command_set.h
@@ -0,0 +1,166 @@
+/* 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, write to the Free Software
+ Foundation, Inc., 59 Temple Place - Suite 330, Boston,
+ MA 02111-1307, USA.
+
+ As a special exception, the authors of SANE give permission for
+ additional uses of the libraries contained in this release of SANE.
+
+ The exception is that, if you link a SANE library with other files
+ to produce an executable, this does not by itself cause the
+ resulting executable to be covered by the GNU General Public
+ License. Your use of that executable is in no way restricted on
+ account of linking the SANE library code into it.
+
+ This exception does not, however, invalidate any other reasons why
+ the executable file might be covered by the GNU General Public
+ License.
+
+ If you submit changes to SANE to the maintainers to be included in
+ a subsequent release, you agree by submitting the changes that
+ those changes may be distributed with this exception intact.
+
+ If you write modifications of your own for SANE, it is your choice
+ whether to permit this exception to apply to your modifications.
+ If you do not wish that, delete this exception notice.
+*/
+
+#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, int* channels,
+ int* total_size) const = 0;
+
+ virtual void init_regs_for_coarse_calibration(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;
+ virtual void init_regs_for_scan(Genesys_Device* dev, const Genesys_Sensor& sensor) 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 search_start_position(Genesys_Device* dev) 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;
+
+ /** Whether the scanner needs to call update_home_sensor_gpio before reading the status of the
+ home sensor. On some chipsets this is unreliable until update_home_sensor_gpio() is called.
+ */
+ virtual bool needs_update_home_sensor_gpio() const { return false; }
+
+ /** Needed on some chipsets before reading the status of the home sensor to make this operation
+ reliable.
+ */
+ virtual void update_home_sensor_gpio(Genesys_Device& dev) const { (void) dev; }
+
+ // 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;
+ /**
+ * search for an black or white area in forward or reverse
+ * direction */
+ virtual void search_strip(Genesys_Device* dev, const Genesys_Sensor& sensor,
+ bool forward, bool black) const = 0;
+
+ /// move scanning head to transparency adapter
+ virtual void move_to_ta(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;
+};
+
+} // namespace genesys
+
+#endif // BACKEND_GENESYS_COMMAND_SET_H