My Marlin configs for Fabrikator Mini and CTC i3 Pro B
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

planner.cpp 122KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100
  1. /**
  2. * Marlin 3D Printer Firmware
  3. * Copyright (c) 2020 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
  4. *
  5. * Based on Sprinter and grbl.
  6. * Copyright (c) 2011 Camiel Gubbels / Erik van der Zalm
  7. *
  8. * This program is free software: you can redistribute it and/or modify
  9. * it under the terms of the GNU General Public License as published by
  10. * the Free Software Foundation, either version 3 of the License, or
  11. * (at your option) any later version.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU General Public License
  19. * along with this program. If not, see <https://www.gnu.org/licenses/>.
  20. *
  21. */
  22. /**
  23. * planner.cpp
  24. *
  25. * Buffer movement commands and manage the acceleration profile plan
  26. *
  27. * Derived from Grbl
  28. * Copyright (c) 2009-2011 Simen Svale Skogsrud
  29. *
  30. * The ring buffer implementation gleaned from the wiring_serial library by David A. Mellis.
  31. *
  32. *
  33. * Reasoning behind the mathematics in this module (in the key of 'Mathematica'):
  34. *
  35. * s == speed, a == acceleration, t == time, d == distance
  36. *
  37. * Basic definitions:
  38. * Speed[s_, a_, t_] := s + (a*t)
  39. * Travel[s_, a_, t_] := Integrate[Speed[s, a, t], t]
  40. *
  41. * Distance to reach a specific speed with a constant acceleration:
  42. * Solve[{Speed[s, a, t] == m, Travel[s, a, t] == d}, d, t]
  43. * d -> (m^2 - s^2)/(2 a) --> estimate_acceleration_distance()
  44. *
  45. * Speed after a given distance of travel with constant acceleration:
  46. * Solve[{Speed[s, a, t] == m, Travel[s, a, t] == d}, m, t]
  47. * m -> Sqrt[2 a d + s^2]
  48. *
  49. * DestinationSpeed[s_, a_, d_] := Sqrt[2 a d + s^2]
  50. *
  51. * When to start braking (di) to reach a specified destination speed (s2) after accelerating
  52. * from initial speed s1 without ever stopping at a plateau:
  53. * Solve[{DestinationSpeed[s1, a, di] == DestinationSpeed[s2, a, d - di]}, di]
  54. * di -> (2 a d - s1^2 + s2^2)/(4 a) --> intersection_distance()
  55. *
  56. * IntersectionDistance[s1_, s2_, a_, d_] := (2 a d - s1^2 + s2^2)/(4 a)
  57. *
  58. * --
  59. *
  60. * The fast inverse function needed for Bézier interpolation for AVR
  61. * was designed, written and tested by Eduardo José Tagle on April/2018
  62. */
  63. #include "planner.h"
  64. #include "stepper.h"
  65. #include "motion.h"
  66. #include "temperature.h"
  67. #include "../lcd/marlinui.h"
  68. #include "../gcode/parser.h"
  69. #include "../MarlinCore.h"
  70. #if HAS_LEVELING
  71. #include "../feature/bedlevel/bedlevel.h"
  72. #endif
  73. #if ENABLED(FILAMENT_WIDTH_SENSOR)
  74. #include "../feature/filwidth.h"
  75. #endif
  76. #if ENABLED(BARICUDA)
  77. #include "../feature/baricuda.h"
  78. #endif
  79. #if ENABLED(MIXING_EXTRUDER)
  80. #include "../feature/mixing.h"
  81. #endif
  82. #if ENABLED(AUTO_POWER_CONTROL)
  83. #include "../feature/power.h"
  84. #endif
  85. #if ENABLED(EXTERNAL_CLOSED_LOOP_CONTROLLER)
  86. #include "../feature/closedloop.h"
  87. #endif
  88. #if ENABLED(BACKLASH_COMPENSATION)
  89. #include "../feature/backlash.h"
  90. #endif
  91. #if ENABLED(CANCEL_OBJECTS)
  92. #include "../feature/cancel_object.h"
  93. #endif
  94. #if ENABLED(POWER_LOSS_RECOVERY)
  95. #include "../feature/powerloss.h"
  96. #endif
  97. #if HAS_CUTTER
  98. #include "../feature/spindle_laser.h"
  99. #endif
  100. // Delay for delivery of first block to the stepper ISR, if the queue contains 2 or
  101. // fewer movements. The delay is measured in milliseconds, and must be less than 250ms
  102. #define BLOCK_DELAY_FOR_1ST_MOVE 100
  103. Planner planner;
  104. // public:
  105. /**
  106. * A ring buffer of moves described in steps
  107. */
  108. block_t Planner::block_buffer[BLOCK_BUFFER_SIZE];
  109. volatile uint8_t Planner::block_buffer_head, // Index of the next block to be pushed
  110. Planner::block_buffer_nonbusy, // Index of the first non-busy block
  111. Planner::block_buffer_planned, // Index of the optimally planned block
  112. Planner::block_buffer_tail; // Index of the busy block, if any
  113. uint16_t Planner::cleaning_buffer_counter; // A counter to disable queuing of blocks
  114. uint8_t Planner::delay_before_delivering; // This counter delays delivery of blocks when queue becomes empty to allow the opportunity of merging blocks
  115. planner_settings_t Planner::settings; // Initialized by settings.load()
  116. #if ENABLED(LASER_POWER_INLINE)
  117. laser_state_t Planner::laser_inline; // Current state for blocks
  118. #endif
  119. uint32_t Planner::max_acceleration_steps_per_s2[XYZE_N]; // (steps/s^2) Derived from mm_per_s2
  120. float Planner::steps_to_mm[XYZE_N]; // (mm) Millimeters per step
  121. #if HAS_JUNCTION_DEVIATION
  122. float Planner::junction_deviation_mm; // (mm) M205 J
  123. #if HAS_LINEAR_E_JERK
  124. float Planner::max_e_jerk[DISTINCT_E]; // Calculated from junction_deviation_mm
  125. #endif
  126. #endif
  127. #if HAS_CLASSIC_JERK
  128. TERN(HAS_LINEAR_E_JERK, xyz_pos_t, xyze_pos_t) Planner::max_jerk;
  129. #endif
  130. #if ENABLED(SD_ABORT_ON_ENDSTOP_HIT)
  131. bool Planner::abort_on_endstop_hit = false;
  132. #endif
  133. #if ENABLED(DISTINCT_E_FACTORS)
  134. uint8_t Planner::last_extruder = 0; // Respond to extruder change
  135. #endif
  136. #if ENABLED(DIRECT_STEPPING)
  137. uint32_t Planner::last_page_step_rate = 0;
  138. xyze_bool_t Planner::last_page_dir{0};
  139. #endif
  140. #if EXTRUDERS
  141. int16_t Planner::flow_percentage[EXTRUDERS] = ARRAY_BY_EXTRUDERS1(100); // Extrusion factor for each extruder
  142. float Planner::e_factor[EXTRUDERS] = ARRAY_BY_EXTRUDERS1(1.0f); // The flow percentage and volumetric multiplier combine to scale E movement
  143. #endif
  144. #if DISABLED(NO_VOLUMETRICS)
  145. float Planner::filament_size[EXTRUDERS], // diameter of filament (in millimeters), typically around 1.75 or 2.85, 0 disables the volumetric calculations for the extruder
  146. Planner::volumetric_area_nominal = CIRCLE_AREA(float(DEFAULT_NOMINAL_FILAMENT_DIA) * 0.5f), // Nominal cross-sectional area
  147. Planner::volumetric_multiplier[EXTRUDERS]; // Reciprocal of cross-sectional area of filament (in mm^2). Pre-calculated to reduce computation in the planner
  148. #endif
  149. #if ENABLED(VOLUMETRIC_EXTRUDER_LIMIT)
  150. float Planner::volumetric_extruder_limit[EXTRUDERS], // max mm^3/sec the extruder is able to handle
  151. Planner::volumetric_extruder_feedrate_limit[EXTRUDERS]; // pre calculated extruder feedrate limit based on volumetric_extruder_limit; pre-calculated to reduce computation in the planner
  152. #endif
  153. #if HAS_LEVELING
  154. bool Planner::leveling_active = false; // Flag that auto bed leveling is enabled
  155. #if ABL_PLANAR
  156. matrix_3x3 Planner::bed_level_matrix; // Transform to compensate for bed level
  157. #endif
  158. #if ENABLED(ENABLE_LEVELING_FADE_HEIGHT)
  159. float Planner::z_fade_height, // Initialized by settings.load()
  160. Planner::inverse_z_fade_height,
  161. Planner::last_fade_z;
  162. #endif
  163. #else
  164. constexpr bool Planner::leveling_active;
  165. #endif
  166. skew_factor_t Planner::skew_factor; // Initialized by settings.load()
  167. #if ENABLED(AUTOTEMP)
  168. float Planner::autotemp_max = 250,
  169. Planner::autotemp_min = 210,
  170. Planner::autotemp_factor = 0.1f;
  171. bool Planner::autotemp_enabled = false;
  172. #endif
  173. // private:
  174. xyze_long_t Planner::position{0};
  175. uint32_t Planner::cutoff_long;
  176. xyze_float_t Planner::previous_speed;
  177. float Planner::previous_nominal_speed_sqr;
  178. #if ENABLED(DISABLE_INACTIVE_EXTRUDER)
  179. uint8_t Planner::g_uc_extruder_last_move[EXTRUDERS] = { 0 };
  180. #endif
  181. #ifdef XY_FREQUENCY_LIMIT
  182. int8_t Planner::xy_freq_limit_hz = XY_FREQUENCY_LIMIT;
  183. float Planner::xy_freq_min_speed_factor = (XY_FREQUENCY_MIN_PERCENT) * 0.01f;
  184. int32_t Planner::xy_freq_min_interval_us = LROUND(1000000.0 / (XY_FREQUENCY_LIMIT));
  185. #endif
  186. #if ENABLED(LIN_ADVANCE)
  187. float Planner::extruder_advance_K[EXTRUDERS]; // Initialized by settings.load()
  188. #endif
  189. #if HAS_POSITION_FLOAT
  190. xyze_pos_t Planner::position_float; // Needed for accurate maths. Steps cannot be used!
  191. #endif
  192. #if IS_KINEMATIC
  193. xyze_pos_t Planner::position_cart;
  194. #endif
  195. #if HAS_WIRED_LCD
  196. volatile uint32_t Planner::block_buffer_runtime_us = 0;
  197. #endif
  198. /**
  199. * Class and Instance Methods
  200. */
  201. Planner::Planner() { init(); }
  202. void Planner::init() {
  203. position.reset();
  204. TERN_(HAS_POSITION_FLOAT, position_float.reset());
  205. TERN_(IS_KINEMATIC, position_cart.reset());
  206. previous_speed.reset();
  207. previous_nominal_speed_sqr = 0;
  208. TERN_(ABL_PLANAR, bed_level_matrix.set_to_identity());
  209. clear_block_buffer();
  210. delay_before_delivering = 0;
  211. #if ENABLED(DIRECT_STEPPING)
  212. last_page_step_rate = 0;
  213. last_page_dir.reset();
  214. #endif
  215. }
  216. #if ENABLED(S_CURVE_ACCELERATION)
  217. #ifdef __AVR__
  218. /**
  219. * This routine returns 0x1000000 / d, getting the inverse as fast as possible.
  220. * A fast-converging iterative Newton-Raphson method can reach full precision in
  221. * just 1 iteration, and takes 211 cycles (worst case; the mean case is less, up
  222. * to 30 cycles for small divisors), instead of the 500 cycles a normal division
  223. * would take.
  224. *
  225. * Inspired by the following page:
  226. * https://stackoverflow.com/questions/27801397/newton-raphson-division-with-big-integers
  227. *
  228. * Suppose we want to calculate floor(2 ^ k / B) where B is a positive integer
  229. * Then, B must be <= 2^k, otherwise, the quotient is 0.
  230. *
  231. * The Newton - Raphson iteration for x = B / 2 ^ k yields:
  232. * q[n + 1] = q[n] * (2 - q[n] * B / 2 ^ k)
  233. *
  234. * This can be rearranged to:
  235. * q[n + 1] = q[n] * (2 ^ (k + 1) - q[n] * B) >> k
  236. *
  237. * Each iteration requires only integer multiplications and bit shifts.
  238. * It doesn't necessarily converge to floor(2 ^ k / B) but in the worst case
  239. * it eventually alternates between floor(2 ^ k / B) and ceil(2 ^ k / B).
  240. * So it checks for this case and extracts floor(2 ^ k / B).
  241. *
  242. * A simple but important optimization for this approach is to truncate
  243. * multiplications (i.e., calculate only the higher bits of the product) in the
  244. * early iterations of the Newton - Raphson method. This is done so the results
  245. * of the early iterations are far from the quotient. Then it doesn't matter if
  246. * they are done inaccurately.
  247. * It's important to pick a good starting value for x. Knowing how many
  248. * digits the divisor has, it can be estimated:
  249. *
  250. * 2^k / x = 2 ^ log2(2^k / x)
  251. * 2^k / x = 2 ^(log2(2^k)-log2(x))
  252. * 2^k / x = 2 ^(k*log2(2)-log2(x))
  253. * 2^k / x = 2 ^ (k-log2(x))
  254. * 2^k / x >= 2 ^ (k-floor(log2(x)))
  255. * floor(log2(x)) is simply the index of the most significant bit set.
  256. *
  257. * If this estimation can be improved even further the number of iterations can be
  258. * reduced a lot, saving valuable execution time.
  259. * The paper "Software Integer Division" by Thomas L.Rodeheffer, Microsoft
  260. * Research, Silicon Valley,August 26, 2008, available at
  261. * https://www.microsoft.com/en-us/research/wp-content/uploads/2008/08/tr-2008-141.pdf
  262. * suggests, for its integer division algorithm, using a table to supply the first
  263. * 8 bits of precision, then, due to the quadratic convergence nature of the
  264. * Newton-Raphon iteration, just 2 iterations should be enough to get maximum
  265. * precision of the division.
  266. * By precomputing values of inverses for small denominator values, just one
  267. * Newton-Raphson iteration is enough to reach full precision.
  268. * This code uses the top 9 bits of the denominator as index.
  269. *
  270. * The AVR assembly function implements this C code using the data below:
  271. *
  272. * // For small divisors, it is best to directly retrieve the results
  273. * if (d <= 110) return pgm_read_dword(&small_inv_tab[d]);
  274. *
  275. * // Compute initial estimation of 0x1000000/x -
  276. * // Get most significant bit set on divider
  277. * uint8_t idx = 0;
  278. * uint32_t nr = d;
  279. * if (!(nr & 0xFF0000)) {
  280. * nr <<= 8; idx += 8;
  281. * if (!(nr & 0xFF0000)) { nr <<= 8; idx += 8; }
  282. * }
  283. * if (!(nr & 0xF00000)) { nr <<= 4; idx += 4; }
  284. * if (!(nr & 0xC00000)) { nr <<= 2; idx += 2; }
  285. * if (!(nr & 0x800000)) { nr <<= 1; idx += 1; }
  286. *
  287. * // Isolate top 9 bits of the denominator, to be used as index into the initial estimation table
  288. * uint32_t tidx = nr >> 15, // top 9 bits. bit8 is always set
  289. * ie = inv_tab[tidx & 0xFF] + 256, // Get the table value. bit9 is always set
  290. * x = idx <= 8 ? (ie >> (8 - idx)) : (ie << (idx - 8)); // Position the estimation at the proper place
  291. *
  292. * x = uint32_t((x * uint64_t(_BV(25) - x * d)) >> 24); // Refine estimation by newton-raphson. 1 iteration is enough
  293. * const uint32_t r = _BV(24) - x * d; // Estimate remainder
  294. * if (r >= d) x++; // Check whether to adjust result
  295. * return uint32_t(x); // x holds the proper estimation
  296. */
  297. static uint32_t get_period_inverse(uint32_t d) {
  298. static const uint8_t inv_tab[256] PROGMEM = {
  299. 255,253,252,250,248,246,244,242,240,238,236,234,233,231,229,227,
  300. 225,224,222,220,218,217,215,213,212,210,208,207,205,203,202,200,
  301. 199,197,195,194,192,191,189,188,186,185,183,182,180,179,178,176,
  302. 175,173,172,170,169,168,166,165,164,162,161,160,158,157,156,154,
  303. 153,152,151,149,148,147,146,144,143,142,141,139,138,137,136,135,
  304. 134,132,131,130,129,128,127,126,125,123,122,121,120,119,118,117,
  305. 116,115,114,113,112,111,110,109,108,107,106,105,104,103,102,101,
  306. 100,99,98,97,96,95,94,93,92,91,90,89,88,88,87,86,
  307. 85,84,83,82,81,80,80,79,78,77,76,75,74,74,73,72,
  308. 71,70,70,69,68,67,66,66,65,64,63,62,62,61,60,59,
  309. 59,58,57,56,56,55,54,53,53,52,51,50,50,49,48,48,
  310. 47,46,46,45,44,43,43,42,41,41,40,39,39,38,37,37,
  311. 36,35,35,34,33,33,32,32,31,30,30,29,28,28,27,27,
  312. 26,25,25,24,24,23,22,22,21,21,20,19,19,18,18,17,
  313. 17,16,15,15,14,14,13,13,12,12,11,10,10,9,9,8,
  314. 8,7,7,6,6,5,5,4,4,3,3,2,2,1,0,0
  315. };
  316. // For small denominators, it is cheaper to directly store the result.
  317. // For bigger ones, just ONE Newton-Raphson iteration is enough to get
  318. // maximum precision we need
  319. static const uint32_t small_inv_tab[111] PROGMEM = {
  320. 16777216,16777216,8388608,5592405,4194304,3355443,2796202,2396745,2097152,1864135,1677721,1525201,1398101,1290555,1198372,1118481,
  321. 1048576,986895,932067,883011,838860,798915,762600,729444,699050,671088,645277,621378,599186,578524,559240,541200,
  322. 524288,508400,493447,479349,466033,453438,441505,430185,419430,409200,399457,390167,381300,372827,364722,356962,
  323. 349525,342392,335544,328965,322638,316551,310689,305040,299593,294337,289262,284359,279620,275036,270600,266305,
  324. 262144,258111,254200,250406,246723,243148,239674,236298,233016,229824,226719,223696,220752,217885,215092,212369,
  325. 209715,207126,204600,202135,199728,197379,195083,192841,190650,188508,186413,184365,182361,180400,178481,176602,
  326. 174762,172960,171196,169466,167772,166111,164482,162885,161319,159783,158275,156796,155344,153919,152520
  327. };
  328. // For small divisors, it is best to directly retrieve the results
  329. if (d <= 110) return pgm_read_dword(&small_inv_tab[d]);
  330. uint8_t r8 = d & 0xFF,
  331. r9 = (d >> 8) & 0xFF,
  332. r10 = (d >> 16) & 0xFF,
  333. r2,r3,r4,r5,r6,r7,r11,r12,r13,r14,r15,r16,r17,r18;
  334. const uint8_t* ptab = inv_tab;
  335. __asm__ __volatile__(
  336. // %8:%7:%6 = interval
  337. // r31:r30: MUST be those registers, and they must point to the inv_tab
  338. A("clr %13") // %13 = 0
  339. // Now we must compute
  340. // result = 0xFFFFFF / d
  341. // %8:%7:%6 = interval
  342. // %16:%15:%14 = nr
  343. // %13 = 0
  344. // A plain division of 24x24 bits should take 388 cycles to complete. We will
  345. // use Newton-Raphson for the calculation, and will strive to get way less cycles
  346. // for the same result - Using C division, it takes 500cycles to complete .
  347. A("clr %3") // idx = 0
  348. A("mov %14,%6")
  349. A("mov %15,%7")
  350. A("mov %16,%8") // nr = interval
  351. A("tst %16") // nr & 0xFF0000 == 0 ?
  352. A("brne 2f") // No, skip this
  353. A("mov %16,%15")
  354. A("mov %15,%14") // nr <<= 8, %14 not needed
  355. A("subi %3,-8") // idx += 8
  356. A("tst %16") // nr & 0xFF0000 == 0 ?
  357. A("brne 2f") // No, skip this
  358. A("mov %16,%15") // nr <<= 8, %14 not needed
  359. A("clr %15") // We clear %14
  360. A("subi %3,-8") // idx += 8
  361. // here %16 != 0 and %16:%15 contains at least 9 MSBits, or both %16:%15 are 0
  362. L("2")
  363. A("cpi %16,0x10") // (nr & 0xF00000) == 0 ?
  364. A("brcc 3f") // No, skip this
  365. A("swap %15") // Swap nibbles
  366. A("swap %16") // Swap nibbles. Low nibble is 0
  367. A("mov %14, %15")
  368. A("andi %14,0x0F") // Isolate low nibble
  369. A("andi %15,0xF0") // Keep proper nibble in %15
  370. A("or %16, %14") // %16:%15 <<= 4
  371. A("subi %3,-4") // idx += 4
  372. L("3")
  373. A("cpi %16,0x40") // (nr & 0xC00000) == 0 ?
  374. A("brcc 4f") // No, skip this
  375. A("add %15,%15")
  376. A("adc %16,%16")
  377. A("add %15,%15")
  378. A("adc %16,%16") // %16:%15 <<= 2
  379. A("subi %3,-2") // idx += 2
  380. L("4")
  381. A("cpi %16,0x80") // (nr & 0x800000) == 0 ?
  382. A("brcc 5f") // No, skip this
  383. A("add %15,%15")
  384. A("adc %16,%16") // %16:%15 <<= 1
  385. A("inc %3") // idx += 1
  386. // Now %16:%15 contains its MSBit set to 1, or %16:%15 is == 0. We are now absolutely sure
  387. // we have at least 9 MSBits available to enter the initial estimation table
  388. L("5")
  389. A("add %15,%15")
  390. A("adc %16,%16") // %16:%15 = tidx = (nr <<= 1), we lose the top MSBit (always set to 1, %16 is the index into the inverse table)
  391. A("add r30,%16") // Only use top 8 bits
  392. A("adc r31,%13") // r31:r30 = inv_tab + (tidx)
  393. A("lpm %14, Z") // %14 = inv_tab[tidx]
  394. A("ldi %15, 1") // %15 = 1 %15:%14 = inv_tab[tidx] + 256
  395. // We must scale the approximation to the proper place
  396. A("clr %16") // %16 will always be 0 here
  397. A("subi %3,8") // idx == 8 ?
  398. A("breq 6f") // yes, no need to scale
  399. A("brcs 7f") // If C=1, means idx < 8, result was negative!
  400. // idx > 8, now %3 = idx - 8. We must perform a left shift. idx range:[1-8]
  401. A("sbrs %3,0") // shift by 1bit position?
  402. A("rjmp 8f") // No
  403. A("add %14,%14")
  404. A("adc %15,%15") // %15:16 <<= 1
  405. L("8")
  406. A("sbrs %3,1") // shift by 2bit position?
  407. A("rjmp 9f") // No
  408. A("add %14,%14")
  409. A("adc %15,%15")
  410. A("add %14,%14")
  411. A("adc %15,%15") // %15:16 <<= 1
  412. L("9")
  413. A("sbrs %3,2") // shift by 4bits position?
  414. A("rjmp 16f") // No
  415. A("swap %15") // Swap nibbles. lo nibble of %15 will always be 0
  416. A("swap %14") // Swap nibbles
  417. A("mov %12,%14")
  418. A("andi %12,0x0F") // isolate low nibble
  419. A("andi %14,0xF0") // and clear it
  420. A("or %15,%12") // %15:%16 <<= 4
  421. L("16")
  422. A("sbrs %3,3") // shift by 8bits position?
  423. A("rjmp 6f") // No, we are done
  424. A("mov %16,%15")
  425. A("mov %15,%14")
  426. A("clr %14")
  427. A("jmp 6f")
  428. // idx < 8, now %3 = idx - 8. Get the count of bits
  429. L("7")
  430. A("neg %3") // %3 = -idx = count of bits to move right. idx range:[1...8]
  431. A("sbrs %3,0") // shift by 1 bit position ?
  432. A("rjmp 10f") // No, skip it
  433. A("asr %15") // (bit7 is always 0 here)
  434. A("ror %14")
  435. L("10")
  436. A("sbrs %3,1") // shift by 2 bit position ?
  437. A("rjmp 11f") // No, skip it
  438. A("asr %15") // (bit7 is always 0 here)
  439. A("ror %14")
  440. A("asr %15") // (bit7 is always 0 here)
  441. A("ror %14")
  442. L("11")
  443. A("sbrs %3,2") // shift by 4 bit position ?
  444. A("rjmp 12f") // No, skip it
  445. A("swap %15") // Swap nibbles
  446. A("andi %14, 0xF0") // Lose the lowest nibble
  447. A("swap %14") // Swap nibbles. Upper nibble is 0
  448. A("or %14,%15") // Pass nibble from upper byte
  449. A("andi %15, 0x0F") // And get rid of that nibble
  450. L("12")
  451. A("sbrs %3,3") // shift by 8 bit position ?
  452. A("rjmp 6f") // No, skip it
  453. A("mov %14,%15")
  454. A("clr %15")
  455. L("6") // %16:%15:%14 = initial estimation of 0x1000000 / d
  456. // Now, we must refine the estimation present on %16:%15:%14 using 1 iteration
  457. // of Newton-Raphson. As it has a quadratic convergence, 1 iteration is enough
  458. // to get more than 18bits of precision (the initial table lookup gives 9 bits of
  459. // precision to start from). 18bits of precision is all what is needed here for result
  460. // %8:%7:%6 = d = interval
  461. // %16:%15:%14 = x = initial estimation of 0x1000000 / d
  462. // %13 = 0
  463. // %3:%2:%1:%0 = working accumulator
  464. // Compute 1<<25 - x*d. Result should never exceed 25 bits and should always be positive
  465. A("clr %0")
  466. A("clr %1")
  467. A("clr %2")
  468. A("ldi %3,2") // %3:%2:%1:%0 = 0x2000000
  469. A("mul %6,%14") // r1:r0 = LO(d) * LO(x)
  470. A("sub %0,r0")
  471. A("sbc %1,r1")
  472. A("sbc %2,%13")
  473. A("sbc %3,%13") // %3:%2:%1:%0 -= LO(d) * LO(x)
  474. A("mul %7,%14") // r1:r0 = MI(d) * LO(x)
  475. A("sub %1,r0")
  476. A("sbc %2,r1" )
  477. A("sbc %3,%13") // %3:%2:%1:%0 -= MI(d) * LO(x) << 8
  478. A("mul %8,%14") // r1:r0 = HI(d) * LO(x)
  479. A("sub %2,r0")
  480. A("sbc %3,r1") // %3:%2:%1:%0 -= MIL(d) * LO(x) << 16
  481. A("mul %6,%15") // r1:r0 = LO(d) * MI(x)
  482. A("sub %1,r0")
  483. A("sbc %2,r1")
  484. A("sbc %3,%13") // %3:%2:%1:%0 -= LO(d) * MI(x) << 8
  485. A("mul %7,%15") // r1:r0 = MI(d) * MI(x)
  486. A("sub %2,r0")
  487. A("sbc %3,r1") // %3:%2:%1:%0 -= MI(d) * MI(x) << 16
  488. A("mul %8,%15") // r1:r0 = HI(d) * MI(x)
  489. A("sub %3,r0") // %3:%2:%1:%0 -= MIL(d) * MI(x) << 24
  490. A("mul %6,%16") // r1:r0 = LO(d) * HI(x)
  491. A("sub %2,r0")
  492. A("sbc %3,r1") // %3:%2:%1:%0 -= LO(d) * HI(x) << 16
  493. A("mul %7,%16") // r1:r0 = MI(d) * HI(x)
  494. A("sub %3,r0") // %3:%2:%1:%0 -= MI(d) * HI(x) << 24
  495. // %3:%2:%1:%0 = (1<<25) - x*d [169]
  496. // We need to multiply that result by x, and we are only interested in the top 24bits of that multiply
  497. // %16:%15:%14 = x = initial estimation of 0x1000000 / d
  498. // %3:%2:%1:%0 = (1<<25) - x*d = acc
  499. // %13 = 0
  500. // result = %11:%10:%9:%5:%4
  501. A("mul %14,%0") // r1:r0 = LO(x) * LO(acc)
  502. A("mov %4,r1")
  503. A("clr %5")
  504. A("clr %9")
  505. A("clr %10")
  506. A("clr %11") // %11:%10:%9:%5:%4 = LO(x) * LO(acc) >> 8
  507. A("mul %15,%0") // r1:r0 = MI(x) * LO(acc)
  508. A("add %4,r0")
  509. A("adc %5,r1")
  510. A("adc %9,%13")
  511. A("adc %10,%13")
  512. A("adc %11,%13") // %11:%10:%9:%5:%4 += MI(x) * LO(acc)
  513. A("mul %16,%0") // r1:r0 = HI(x) * LO(acc)
  514. A("add %5,r0")
  515. A("adc %9,r1")
  516. A("adc %10,%13")
  517. A("adc %11,%13") // %11:%10:%9:%5:%4 += MI(x) * LO(acc) << 8
  518. A("mul %14,%1") // r1:r0 = LO(x) * MIL(acc)
  519. A("add %4,r0")
  520. A("adc %5,r1")
  521. A("adc %9,%13")
  522. A("adc %10,%13")
  523. A("adc %11,%13") // %11:%10:%9:%5:%4 = LO(x) * MIL(acc)
  524. A("mul %15,%1") // r1:r0 = MI(x) * MIL(acc)
  525. A("add %5,r0")
  526. A("adc %9,r1")
  527. A("adc %10,%13")
  528. A("adc %11,%13") // %11:%10:%9:%5:%4 += MI(x) * MIL(acc) << 8
  529. A("mul %16,%1") // r1:r0 = HI(x) * MIL(acc)
  530. A("add %9,r0")
  531. A("adc %10,r1")
  532. A("adc %11,%13") // %11:%10:%9:%5:%4 += MI(x) * MIL(acc) << 16
  533. A("mul %14,%2") // r1:r0 = LO(x) * MIH(acc)
  534. A("add %5,r0")
  535. A("adc %9,r1")
  536. A("adc %10,%13")
  537. A("adc %11,%13") // %11:%10:%9:%5:%4 = LO(x) * MIH(acc) << 8
  538. A("mul %15,%2") // r1:r0 = MI(x) * MIH(acc)
  539. A("add %9,r0")
  540. A("adc %10,r1")
  541. A("adc %11,%13") // %11:%10:%9:%5:%4 += MI(x) * MIH(acc) << 16
  542. A("mul %16,%2") // r1:r0 = HI(x) * MIH(acc)
  543. A("add %10,r0")
  544. A("adc %11,r1") // %11:%10:%9:%5:%4 += MI(x) * MIH(acc) << 24
  545. A("mul %14,%3") // r1:r0 = LO(x) * HI(acc)
  546. A("add %9,r0")
  547. A("adc %10,r1")
  548. A("adc %11,%13") // %11:%10:%9:%5:%4 = LO(x) * HI(acc) << 16
  549. A("mul %15,%3") // r1:r0 = MI(x) * HI(acc)
  550. A("add %10,r0")
  551. A("adc %11,r1") // %11:%10:%9:%5:%4 += MI(x) * HI(acc) << 24
  552. A("mul %16,%3") // r1:r0 = HI(x) * HI(acc)
  553. A("add %11,r0") // %11:%10:%9:%5:%4 += MI(x) * HI(acc) << 32
  554. // At this point, %11:%10:%9 contains the new estimation of x.
  555. // Finally, we must correct the result. Estimate remainder as
  556. // (1<<24) - x*d
  557. // %11:%10:%9 = x
  558. // %8:%7:%6 = d = interval" "\n\t"
  559. A("ldi %3,1")
  560. A("clr %2")
  561. A("clr %1")
  562. A("clr %0") // %3:%2:%1:%0 = 0x1000000
  563. A("mul %6,%9") // r1:r0 = LO(d) * LO(x)
  564. A("sub %0,r0")
  565. A("sbc %1,r1")
  566. A("sbc %2,%13")
  567. A("sbc %3,%13") // %3:%2:%1:%0 -= LO(d) * LO(x)
  568. A("mul %7,%9") // r1:r0 = MI(d) * LO(x)
  569. A("sub %1,r0")
  570. A("sbc %2,r1")
  571. A("sbc %3,%13") // %3:%2:%1:%0 -= MI(d) * LO(x) << 8
  572. A("mul %8,%9") // r1:r0 = HI(d) * LO(x)
  573. A("sub %2,r0")
  574. A("sbc %3,r1") // %3:%2:%1:%0 -= MIL(d) * LO(x) << 16
  575. A("mul %6,%10") // r1:r0 = LO(d) * MI(x)
  576. A("sub %1,r0")
  577. A("sbc %2,r1")
  578. A("sbc %3,%13") // %3:%2:%1:%0 -= LO(d) * MI(x) << 8
  579. A("mul %7,%10") // r1:r0 = MI(d) * MI(x)
  580. A("sub %2,r0")
  581. A("sbc %3,r1") // %3:%2:%1:%0 -= MI(d) * MI(x) << 16
  582. A("mul %8,%10") // r1:r0 = HI(d) * MI(x)
  583. A("sub %3,r0") // %3:%2:%1:%0 -= MIL(d) * MI(x) << 24
  584. A("mul %6,%11") // r1:r0 = LO(d) * HI(x)
  585. A("sub %2,r0")
  586. A("sbc %3,r1") // %3:%2:%1:%0 -= LO(d) * HI(x) << 16
  587. A("mul %7,%11") // r1:r0 = MI(d) * HI(x)
  588. A("sub %3,r0") // %3:%2:%1:%0 -= MI(d) * HI(x) << 24
  589. // %3:%2:%1:%0 = r = (1<<24) - x*d
  590. // %8:%7:%6 = d = interval
  591. // Perform the final correction
  592. A("sub %0,%6")
  593. A("sbc %1,%7")
  594. A("sbc %2,%8") // r -= d
  595. A("brcs 14f") // if ( r >= d)
  596. // %11:%10:%9 = x
  597. A("ldi %3,1")
  598. A("add %9,%3")
  599. A("adc %10,%13")
  600. A("adc %11,%13") // x++
  601. L("14")
  602. // Estimation is done. %11:%10:%9 = x
  603. A("clr __zero_reg__") // Make C runtime happy
  604. // [211 cycles total]
  605. : "=r" (r2),
  606. "=r" (r3),
  607. "=r" (r4),
  608. "=d" (r5),
  609. "=r" (r6),
  610. "=r" (r7),
  611. "+r" (r8),
  612. "+r" (r9),
  613. "+r" (r10),
  614. "=d" (r11),
  615. "=r" (r12),
  616. "=r" (r13),
  617. "=d" (r14),
  618. "=d" (r15),
  619. "=d" (r16),
  620. "=d" (r17),
  621. "=d" (r18),
  622. "+z" (ptab)
  623. :
  624. : "r0", "r1", "cc"
  625. );
  626. // Return the result
  627. return r11 | (uint16_t(r12) << 8) | (uint32_t(r13) << 16);
  628. }
  629. #else
  630. // All other 32-bit MPUs can easily do inverse using hardware division,
  631. // so we don't need to reduce precision or to use assembly language at all.
  632. // This routine, for all other archs, returns 0x100000000 / d ~= 0xFFFFFFFF / d
  633. static FORCE_INLINE uint32_t get_period_inverse(const uint32_t d) {
  634. return d ? 0xFFFFFFFF / d : 0xFFFFFFFF;
  635. }
  636. #endif
  637. #endif
  638. #define MINIMAL_STEP_RATE 120
  639. /**
  640. * Get the current block for processing
  641. * and mark the block as busy.
  642. * Return nullptr if the buffer is empty
  643. * or if there is a first-block delay.
  644. *
  645. * WARNING: Called from Stepper ISR context!
  646. */
  647. block_t* Planner::get_current_block() {
  648. // Get the number of moves in the planner queue so far
  649. const uint8_t nr_moves = movesplanned();
  650. // If there are any moves queued ...
  651. if (nr_moves) {
  652. // If there is still delay of delivery of blocks running, decrement it
  653. if (delay_before_delivering) {
  654. --delay_before_delivering;
  655. // If the number of movements queued is less than 3, and there is still time
  656. // to wait, do not deliver anything
  657. if (nr_moves < 3 && delay_before_delivering) return nullptr;
  658. delay_before_delivering = 0;
  659. }
  660. // If we are here, there is no excuse to deliver the block
  661. block_t * const block = &block_buffer[block_buffer_tail];
  662. // No trapezoid calculated? Don't execute yet.
  663. if (TEST(block->flag, BLOCK_BIT_RECALCULATE)) return nullptr;
  664. // We can't be sure how long an active block will take, so don't count it.
  665. TERN_(HAS_WIRED_LCD, block_buffer_runtime_us -= block->segment_time_us);
  666. // As this block is busy, advance the nonbusy block pointer
  667. block_buffer_nonbusy = next_block_index(block_buffer_tail);
  668. // Push block_buffer_planned pointer, if encountered.
  669. if (block_buffer_tail == block_buffer_planned)
  670. block_buffer_planned = block_buffer_nonbusy;
  671. // Return the block
  672. return block;
  673. }
  674. // The queue became empty
  675. TERN_(HAS_WIRED_LCD, clear_block_buffer_runtime()); // paranoia. Buffer is empty now - so reset accumulated time to zero.
  676. return nullptr;
  677. }
  678. /**
  679. * Calculate trapezoid parameters, multiplying the entry- and exit-speeds
  680. * by the provided factors.
  681. **
  682. * ############ VERY IMPORTANT ############
  683. * NOTE that the PRECONDITION to call this function is that the block is
  684. * NOT BUSY and it is marked as RECALCULATE. That WARRANTIES the Stepper ISR
  685. * is not and will not use the block while we modify it, so it is safe to
  686. * alter its values.
  687. */
  688. void Planner::calculate_trapezoid_for_block(block_t* const block, const float &entry_factor, const float &exit_factor) {
  689. uint32_t initial_rate = CEIL(block->nominal_rate * entry_factor),
  690. final_rate = CEIL(block->nominal_rate * exit_factor); // (steps per second)
  691. // Limit minimal step rate (Otherwise the timer will overflow.)
  692. NOLESS(initial_rate, uint32_t(MINIMAL_STEP_RATE));
  693. NOLESS(final_rate, uint32_t(MINIMAL_STEP_RATE));
  694. #if ENABLED(S_CURVE_ACCELERATION)
  695. uint32_t cruise_rate = initial_rate;
  696. #endif
  697. const int32_t accel = block->acceleration_steps_per_s2;
  698. // Steps required for acceleration, deceleration to/from nominal rate
  699. uint32_t accelerate_steps = CEIL(estimate_acceleration_distance(initial_rate, block->nominal_rate, accel)),
  700. decelerate_steps = FLOOR(estimate_acceleration_distance(block->nominal_rate, final_rate, -accel));
  701. // Steps between acceleration and deceleration, if any
  702. int32_t plateau_steps = block->step_event_count - accelerate_steps - decelerate_steps;
  703. // Does accelerate_steps + decelerate_steps exceed step_event_count?
  704. // Then we can't possibly reach the nominal rate, there will be no cruising.
  705. // Use intersection_distance() to calculate accel / braking time in order to
  706. // reach the final_rate exactly at the end of this block.
  707. if (plateau_steps < 0) {
  708. const float accelerate_steps_float = CEIL(intersection_distance(initial_rate, final_rate, accel, block->step_event_count));
  709. accelerate_steps = _MIN(uint32_t(_MAX(accelerate_steps_float, 0)), block->step_event_count);
  710. plateau_steps = 0;
  711. #if ENABLED(S_CURVE_ACCELERATION)
  712. // We won't reach the cruising rate. Let's calculate the speed we will reach
  713. cruise_rate = final_speed(initial_rate, accel, accelerate_steps);
  714. #endif
  715. }
  716. #if ENABLED(S_CURVE_ACCELERATION)
  717. else // We have some plateau time, so the cruise rate will be the nominal rate
  718. cruise_rate = block->nominal_rate;
  719. #endif
  720. #if ENABLED(S_CURVE_ACCELERATION)
  721. // Jerk controlled speed requires to express speed versus time, NOT steps
  722. uint32_t acceleration_time = ((float)(cruise_rate - initial_rate) / accel) * (STEPPER_TIMER_RATE),
  723. deceleration_time = ((float)(cruise_rate - final_rate) / accel) * (STEPPER_TIMER_RATE),
  724. // And to offload calculations from the ISR, we also calculate the inverse of those times here
  725. acceleration_time_inverse = get_period_inverse(acceleration_time),
  726. deceleration_time_inverse = get_period_inverse(deceleration_time);
  727. #endif
  728. // Store new block parameters
  729. block->accelerate_until = accelerate_steps;
  730. block->decelerate_after = accelerate_steps + plateau_steps;
  731. block->initial_rate = initial_rate;
  732. #if ENABLED(S_CURVE_ACCELERATION)
  733. block->acceleration_time = acceleration_time;
  734. block->deceleration_time = deceleration_time;
  735. block->acceleration_time_inverse = acceleration_time_inverse;
  736. block->deceleration_time_inverse = deceleration_time_inverse;
  737. block->cruise_rate = cruise_rate;
  738. #endif
  739. block->final_rate = final_rate;
  740. /**
  741. * Laser trapezoid calculations
  742. *
  743. * Approximate the trapezoid with the laser, incrementing the power every `entry_per` while accelerating
  744. * and decrementing it every `exit_power_per` while decelerating, thus ensuring power is related to feedrate.
  745. *
  746. * LASER_POWER_INLINE_TRAPEZOID_CONT doesn't need this as it continuously approximates
  747. *
  748. * Note this may behave unreliably when running with S_CURVE_ACCELERATION
  749. */
  750. #if ENABLED(LASER_POWER_INLINE_TRAPEZOID)
  751. if (block->laser.power > 0) { // No need to care if power == 0
  752. const uint8_t entry_power = block->laser.power * entry_factor; // Power on block entry
  753. #if DISABLED(LASER_POWER_INLINE_TRAPEZOID_CONT)
  754. // Speedup power
  755. const uint8_t entry_power_diff = block->laser.power - entry_power;
  756. if (entry_power_diff) {
  757. block->laser.entry_per = accelerate_steps / entry_power_diff;
  758. block->laser.power_entry = entry_power;
  759. }
  760. else {
  761. block->laser.entry_per = 0;
  762. block->laser.power_entry = block->laser.power;
  763. }
  764. // Slowdown power
  765. const uint8_t exit_power = block->laser.power * exit_factor, // Power on block entry
  766. exit_power_diff = block->laser.power - exit_power;
  767. if (exit_power_diff) {
  768. block->laser.exit_per = (block->step_event_count - block->decelerate_after) / exit_power_diff;
  769. block->laser.power_exit = exit_power;
  770. }
  771. else {
  772. block->laser.exit_per = 0;
  773. block->laser.power_exit = block->laser.power;
  774. }
  775. #else
  776. block->laser.power_entry = entry_power;
  777. #endif
  778. }
  779. #endif
  780. }
  781. /* PLANNER SPEED DEFINITION
  782. +--------+ <- current->nominal_speed
  783. / \
  784. current->entry_speed -> + \
  785. | + <- next->entry_speed (aka exit speed)
  786. +-------------+
  787. time -->
  788. Recalculates the motion plan according to the following basic guidelines:
  789. 1. Go over every feasible block sequentially in reverse order and calculate the junction speeds
  790. (i.e. current->entry_speed) such that:
  791. a. No junction speed exceeds the pre-computed maximum junction speed limit or nominal speeds of
  792. neighboring blocks.
  793. b. A block entry speed cannot exceed one reverse-computed from its exit speed (next->entry_speed)
  794. with a maximum allowable deceleration over the block travel distance.
  795. c. The last (or newest appended) block is planned from a complete stop (an exit speed of zero).
  796. 2. Go over every block in chronological (forward) order and dial down junction speed values if
  797. a. The exit speed exceeds the one forward-computed from its entry speed with the maximum allowable
  798. acceleration over the block travel distance.
  799. When these stages are complete, the planner will have maximized the velocity profiles throughout the all
  800. of the planner blocks, where every block is operating at its maximum allowable acceleration limits. In
  801. other words, for all of the blocks in the planner, the plan is optimal and no further speed improvements
  802. are possible. If a new block is added to the buffer, the plan is recomputed according to the said
  803. guidelines for a new optimal plan.
  804. To increase computational efficiency of these guidelines, a set of planner block pointers have been
  805. created to indicate stop-compute points for when the planner guidelines cannot logically make any further
  806. changes or improvements to the plan when in normal operation and new blocks are streamed and added to the
  807. planner buffer. For example, if a subset of sequential blocks in the planner have been planned and are
  808. bracketed by junction velocities at their maximums (or by the first planner block as well), no new block
  809. added to the planner buffer will alter the velocity profiles within them. So we no longer have to compute
  810. them. Or, if a set of sequential blocks from the first block in the planner (or a optimal stop-compute
  811. point) are all accelerating, they are all optimal and can not be altered by a new block added to the
  812. planner buffer, as this will only further increase the plan speed to chronological blocks until a maximum
  813. junction velocity is reached. However, if the operational conditions of the plan changes from infrequently
  814. used feed holds or feedrate overrides, the stop-compute pointers will be reset and the entire plan is
  815. recomputed as stated in the general guidelines.
  816. Planner buffer index mapping:
  817. - block_buffer_tail: Points to the beginning of the planner buffer. First to be executed or being executed.
  818. - block_buffer_head: Points to the buffer block after the last block in the buffer. Used to indicate whether
  819. the buffer is full or empty. As described for standard ring buffers, this block is always empty.
  820. - block_buffer_planned: Points to the first buffer block after the last optimally planned block for normal
  821. streaming operating conditions. Use for planning optimizations by avoiding recomputing parts of the
  822. planner buffer that don't change with the addition of a new block, as describe above. In addition,
  823. this block can never be less than block_buffer_tail and will always be pushed forward and maintain
  824. this requirement when encountered by the Planner::release_current_block() routine during a cycle.
  825. NOTE: Since the planner only computes on what's in the planner buffer, some motions with lots of short
  826. line segments, like G2/3 arcs or complex curves, may seem to move slow. This is because there simply isn't
  827. enough combined distance traveled in the entire buffer to accelerate up to the nominal speed and then
  828. decelerate to a complete stop at the end of the buffer, as stated by the guidelines. If this happens and
  829. becomes an annoyance, there are a few simple solutions: (1) Maximize the machine acceleration. The planner
  830. will be able to compute higher velocity profiles within the same combined distance. (2) Maximize line
  831. motion(s) distance per block to a desired tolerance. The more combined distance the planner has to use,
  832. the faster it can go. (3) Maximize the planner buffer size. This also will increase the combined distance
  833. for the planner to compute over. It also increases the number of computations the planner has to perform
  834. to compute an optimal plan, so select carefully.
  835. */
  836. // The kernel called by recalculate() when scanning the plan from last to first entry.
  837. void Planner::reverse_pass_kernel(block_t* const current, const block_t * const next) {
  838. if (current) {
  839. // If entry speed is already at the maximum entry speed, and there was no change of speed
  840. // in the next block, there is no need to recheck. Block is cruising and there is no need to
  841. // compute anything for this block,
  842. // If not, block entry speed needs to be recalculated to ensure maximum possible planned speed.
  843. const float max_entry_speed_sqr = current->max_entry_speed_sqr;
  844. // Compute maximum entry speed decelerating over the current block from its exit speed.
  845. // If not at the maximum entry speed, or the previous block entry speed changed
  846. if (current->entry_speed_sqr != max_entry_speed_sqr || (next && TEST(next->flag, BLOCK_BIT_RECALCULATE))) {
  847. // If nominal length true, max junction speed is guaranteed to be reached.
  848. // If a block can de/ac-celerate from nominal speed to zero within the length of the block, then
  849. // the current block and next block junction speeds are guaranteed to always be at their maximum
  850. // junction speeds in deceleration and acceleration, respectively. This is due to how the current
  851. // block nominal speed limits both the current and next maximum junction speeds. Hence, in both
  852. // the reverse and forward planners, the corresponding block junction speed will always be at the
  853. // the maximum junction speed and may always be ignored for any speed reduction checks.
  854. const float new_entry_speed_sqr = TEST(current->flag, BLOCK_BIT_NOMINAL_LENGTH)
  855. ? max_entry_speed_sqr
  856. : _MIN(max_entry_speed_sqr, max_allowable_speed_sqr(-current->acceleration, next ? next->entry_speed_sqr : sq(float(MINIMUM_PLANNER_SPEED)), current->millimeters));
  857. if (current->entry_speed_sqr != new_entry_speed_sqr) {
  858. // Need to recalculate the block speed - Mark it now, so the stepper
  859. // ISR does not consume the block before being recalculated
  860. SBI(current->flag, BLOCK_BIT_RECALCULATE);
  861. // But there is an inherent race condition here, as the block may have
  862. // become BUSY just before being marked RECALCULATE, so check for that!
  863. if (stepper.is_block_busy(current)) {
  864. // Block became busy. Clear the RECALCULATE flag (no point in
  865. // recalculating BUSY blocks). And don't set its speed, as it can't
  866. // be updated at this time.
  867. CBI(current->flag, BLOCK_BIT_RECALCULATE);
  868. }
  869. else {
  870. // Block is not BUSY so this is ahead of the Stepper ISR:
  871. // Just Set the new entry speed.
  872. current->entry_speed_sqr = new_entry_speed_sqr;
  873. }
  874. }
  875. }
  876. }
  877. }
  878. /**
  879. * recalculate() needs to go over the current plan twice.
  880. * Once in reverse and once forward. This implements the reverse pass.
  881. */
  882. void Planner::reverse_pass() {
  883. // Initialize block index to the last block in the planner buffer.
  884. uint8_t block_index = prev_block_index(block_buffer_head);
  885. // Read the index of the last buffer planned block.
  886. // The ISR may change it so get a stable local copy.
  887. uint8_t planned_block_index = block_buffer_planned;
  888. // If there was a race condition and block_buffer_planned was incremented
  889. // or was pointing at the head (queue empty) break loop now and avoid
  890. // planning already consumed blocks
  891. if (planned_block_index == block_buffer_head) return;
  892. // Reverse Pass: Coarsely maximize all possible deceleration curves back-planning from the last
  893. // block in buffer. Cease planning when the last optimal planned or tail pointer is reached.
  894. // NOTE: Forward pass will later refine and correct the reverse pass to create an optimal plan.
  895. const block_t *next = nullptr;
  896. while (block_index != planned_block_index) {
  897. // Perform the reverse pass
  898. block_t *current = &block_buffer[block_index];
  899. // Only consider non sync and page blocks
  900. if (!TEST(current->flag, BLOCK_BIT_SYNC_POSITION) && !IS_PAGE(current)) {
  901. reverse_pass_kernel(current, next);
  902. next = current;
  903. }
  904. // Advance to the next
  905. block_index = prev_block_index(block_index);
  906. // The ISR could advance the block_buffer_planned while we were doing the reverse pass.
  907. // We must try to avoid using an already consumed block as the last one - So follow
  908. // changes to the pointer and make sure to limit the loop to the currently busy block
  909. while (planned_block_index != block_buffer_planned) {
  910. // If we reached the busy block or an already processed block, break the loop now
  911. if (block_index == planned_block_index) return;
  912. // Advance the pointer, following the busy block
  913. planned_block_index = next_block_index(planned_block_index);
  914. }
  915. }
  916. }
  917. // The kernel called by recalculate() when scanning the plan from first to last entry.
  918. void Planner::forward_pass_kernel(const block_t* const previous, block_t* const current, const uint8_t block_index) {
  919. if (previous) {
  920. // If the previous block is an acceleration block, too short to complete the full speed
  921. // change, adjust the entry speed accordingly. Entry speeds have already been reset,
  922. // maximized, and reverse-planned. If nominal length is set, max junction speed is
  923. // guaranteed to be reached. No need to recheck.
  924. if (!TEST(previous->flag, BLOCK_BIT_NOMINAL_LENGTH) &&
  925. previous->entry_speed_sqr < current->entry_speed_sqr) {
  926. // Compute the maximum allowable speed
  927. const float new_entry_speed_sqr = max_allowable_speed_sqr(-previous->acceleration, previous->entry_speed_sqr, previous->millimeters);
  928. // If true, current block is full-acceleration and we can move the planned pointer forward.
  929. if (new_entry_speed_sqr < current->entry_speed_sqr) {
  930. // Mark we need to recompute the trapezoidal shape, and do it now,
  931. // so the stepper ISR does not consume the block before being recalculated
  932. SBI(current->flag, BLOCK_BIT_RECALCULATE);
  933. // But there is an inherent race condition here, as the block maybe
  934. // became BUSY, just before it was marked as RECALCULATE, so check
  935. // if that is the case!
  936. if (stepper.is_block_busy(current)) {
  937. // Block became busy. Clear the RECALCULATE flag (no point in
  938. // recalculating BUSY blocks and don't set its speed, as it can't
  939. // be updated at this time.
  940. CBI(current->flag, BLOCK_BIT_RECALCULATE);
  941. }
  942. else {
  943. // Block is not BUSY, we won the race against the Stepper ISR:
  944. // Always <= max_entry_speed_sqr. Backward pass sets this.
  945. current->entry_speed_sqr = new_entry_speed_sqr; // Always <= max_entry_speed_sqr. Backward pass sets this.
  946. // Set optimal plan pointer.
  947. block_buffer_planned = block_index;
  948. }
  949. }
  950. }
  951. // Any block set at its maximum entry speed also creates an optimal plan up to this
  952. // point in the buffer. When the plan is bracketed by either the beginning of the
  953. // buffer and a maximum entry speed or two maximum entry speeds, every block in between
  954. // cannot logically be further improved. Hence, we don't have to recompute them anymore.
  955. if (current->entry_speed_sqr == current->max_entry_speed_sqr)
  956. block_buffer_planned = block_index;
  957. }
  958. }
  959. /**
  960. * recalculate() needs to go over the current plan twice.
  961. * Once in reverse and once forward. This implements the forward pass.
  962. */
  963. void Planner::forward_pass() {
  964. // Forward Pass: Forward plan the acceleration curve from the planned pointer onward.
  965. // Also scans for optimal plan breakpoints and appropriately updates the planned pointer.
  966. // Begin at buffer planned pointer. Note that block_buffer_planned can be modified
  967. // by the stepper ISR, so read it ONCE. It it guaranteed that block_buffer_planned
  968. // will never lead head, so the loop is safe to execute. Also note that the forward
  969. // pass will never modify the values at the tail.
  970. uint8_t block_index = block_buffer_planned;
  971. block_t *block;
  972. const block_t * previous = nullptr;
  973. while (block_index != block_buffer_head) {
  974. // Perform the forward pass
  975. block = &block_buffer[block_index];
  976. // Skip SYNC and page blocks
  977. if (!TEST(block->flag, BLOCK_BIT_SYNC_POSITION) && !IS_PAGE(block)) {
  978. // If there's no previous block or the previous block is not
  979. // BUSY (thus, modifiable) run the forward_pass_kernel. Otherwise,
  980. // the previous block became BUSY, so assume the current block's
  981. // entry speed can't be altered (since that would also require
  982. // updating the exit speed of the previous block).
  983. if (!previous || !stepper.is_block_busy(previous))
  984. forward_pass_kernel(previous, block, block_index);
  985. previous = block;
  986. }
  987. // Advance to the previous
  988. block_index = next_block_index(block_index);
  989. }
  990. }
  991. /**
  992. * Recalculate the trapezoid speed profiles for all blocks in the plan
  993. * according to the entry_factor for each junction. Must be called by
  994. * recalculate() after updating the blocks.
  995. */
  996. void Planner::recalculate_trapezoids() {
  997. // The tail may be changed by the ISR so get a local copy.
  998. uint8_t block_index = block_buffer_tail,
  999. head_block_index = block_buffer_head;
  1000. // Since there could be a sync block in the head of the queue, and the
  1001. // next loop must not recalculate the head block (as it needs to be
  1002. // specially handled), scan backwards to the first non-SYNC block.
  1003. while (head_block_index != block_index) {
  1004. // Go back (head always point to the first free block)
  1005. const uint8_t prev_index = prev_block_index(head_block_index);
  1006. // Get the pointer to the block
  1007. block_t *prev = &block_buffer[prev_index];
  1008. // If not dealing with a sync block, we are done. The last block is not a SYNC block
  1009. if (!TEST(prev->flag, BLOCK_BIT_SYNC_POSITION)) break;
  1010. // Examine the previous block. This and all following are SYNC blocks
  1011. head_block_index = prev_index;
  1012. }
  1013. // Go from the tail (currently executed block) to the first block, without including it)
  1014. block_t *block = nullptr, *next = nullptr;
  1015. float current_entry_speed = 0.0, next_entry_speed = 0.0;
  1016. while (block_index != head_block_index) {
  1017. next = &block_buffer[block_index];
  1018. // Skip sync and page blocks
  1019. if (!TEST(next->flag, BLOCK_BIT_SYNC_POSITION) && !IS_PAGE(next)) {
  1020. next_entry_speed = SQRT(next->entry_speed_sqr);
  1021. if (block) {
  1022. // Recalculate if current block entry or exit junction speed has changed.
  1023. if (TEST(block->flag, BLOCK_BIT_RECALCULATE) || TEST(next->flag, BLOCK_BIT_RECALCULATE)) {
  1024. // Mark the current block as RECALCULATE, to protect it from the Stepper ISR running it.
  1025. // Note that due to the above condition, there's a chance the current block isn't marked as
  1026. // RECALCULATE yet, but the next one is. That's the reason for the following line.
  1027. SBI(block->flag, BLOCK_BIT_RECALCULATE);
  1028. // But there is an inherent race condition here, as the block maybe
  1029. // became BUSY, just before it was marked as RECALCULATE, so check
  1030. // if that is the case!
  1031. if (!stepper.is_block_busy(block)) {
  1032. // Block is not BUSY, we won the race against the Stepper ISR:
  1033. // NOTE: Entry and exit factors always > 0 by all previous logic operations.
  1034. const float current_nominal_speed = SQRT(block->nominal_speed_sqr),
  1035. nomr = 1.0f / current_nominal_speed;
  1036. calculate_trapezoid_for_block(block, current_entry_speed * nomr, next_entry_speed * nomr);
  1037. #if ENABLED(LIN_ADVANCE)
  1038. if (block->use_advance_lead) {
  1039. const float comp = block->e_D_ratio * extruder_advance_K[active_extruder] * settings.axis_steps_per_mm[E_AXIS];
  1040. block->max_adv_steps = current_nominal_speed * comp;
  1041. block->final_adv_steps = next_entry_speed * comp;
  1042. }
  1043. #endif
  1044. }
  1045. // Reset current only to ensure next trapezoid is computed - The
  1046. // stepper is free to use the block from now on.
  1047. CBI(block->flag, BLOCK_BIT_RECALCULATE);
  1048. }
  1049. }
  1050. block = next;
  1051. current_entry_speed = next_entry_speed;
  1052. }
  1053. block_index = next_block_index(block_index);
  1054. }
  1055. // Last/newest block in buffer. Exit speed is set with MINIMUM_PLANNER_SPEED. Always recalculated.
  1056. if (next) {
  1057. // Mark the next(last) block as RECALCULATE, to prevent the Stepper ISR running it.
  1058. // As the last block is always recalculated here, there is a chance the block isn't
  1059. // marked as RECALCULATE yet. That's the reason for the following line.
  1060. SBI(next->flag, BLOCK_BIT_RECALCULATE);
  1061. // But there is an inherent race condition here, as the block maybe
  1062. // became BUSY, just before it was marked as RECALCULATE, so check
  1063. // if that is the case!
  1064. if (!stepper.is_block_busy(block)) {
  1065. // Block is not BUSY, we won the race against the Stepper ISR:
  1066. const float next_nominal_speed = SQRT(next->nominal_speed_sqr),
  1067. nomr = 1.0f / next_nominal_speed;
  1068. calculate_trapezoid_for_block(next, next_entry_speed * nomr, float(MINIMUM_PLANNER_SPEED) * nomr);
  1069. #if ENABLED(LIN_ADVANCE)
  1070. if (next->use_advance_lead) {
  1071. const float comp = next->e_D_ratio * extruder_advance_K[active_extruder] * settings.axis_steps_per_mm[E_AXIS];
  1072. next->max_adv_steps = next_nominal_speed * comp;
  1073. next->final_adv_steps = (MINIMUM_PLANNER_SPEED) * comp;
  1074. }
  1075. #endif
  1076. }
  1077. // Reset next only to ensure its trapezoid is computed - The stepper is free to use
  1078. // the block from now on.
  1079. CBI(next->flag, BLOCK_BIT_RECALCULATE);
  1080. }
  1081. }
  1082. void Planner::recalculate() {
  1083. // Initialize block index to the last block in the planner buffer.
  1084. const uint8_t block_index = prev_block_index(block_buffer_head);
  1085. // If there is just one block, no planning can be done. Avoid it!
  1086. if (block_index != block_buffer_planned) {
  1087. reverse_pass();
  1088. forward_pass();
  1089. }
  1090. recalculate_trapezoids();
  1091. }
  1092. #if ENABLED(AUTOTEMP)
  1093. void Planner::getHighESpeed() {
  1094. static float oldt = 0;
  1095. if (!autotemp_enabled) return;
  1096. if (thermalManager.degTargetHotend(0) + 2 < autotemp_min) return; // probably temperature set to zero.
  1097. float high = 0.0;
  1098. for (uint8_t b = block_buffer_tail; b != block_buffer_head; b = next_block_index(b)) {
  1099. block_t* block = &block_buffer[b];
  1100. if (block->steps.x || block->steps.y || block->steps.z) {
  1101. const float se = (float)block->steps.e / block->step_event_count * SQRT(block->nominal_speed_sqr); // mm/sec;
  1102. NOLESS(high, se);
  1103. }
  1104. }
  1105. float t = autotemp_min + high * autotemp_factor;
  1106. LIMIT(t, autotemp_min, autotemp_max);
  1107. if (t < oldt) t = t * (1 - float(AUTOTEMP_OLDWEIGHT)) + oldt * float(AUTOTEMP_OLDWEIGHT);
  1108. oldt = t;
  1109. thermalManager.setTargetHotend(t, 0);
  1110. }
  1111. #endif // AUTOTEMP
  1112. /**
  1113. * Maintain fans, paste extruder pressure,
  1114. */
  1115. void Planner::check_axes_activity() {
  1116. #if ANY(DISABLE_X, DISABLE_Y, DISABLE_Z, DISABLE_E)
  1117. xyze_bool_t axis_active = { false };
  1118. #endif
  1119. #if HAS_FAN
  1120. uint8_t tail_fan_speed[FAN_COUNT];
  1121. #endif
  1122. #if ENABLED(BARICUDA)
  1123. #if HAS_HEATER_1
  1124. uint8_t tail_valve_pressure;
  1125. #endif
  1126. #if HAS_HEATER_2
  1127. uint8_t tail_e_to_p_pressure;
  1128. #endif
  1129. #endif
  1130. if (has_blocks_queued()) {
  1131. #if HAS_FAN || ENABLED(BARICUDA)
  1132. block_t *block = &block_buffer[block_buffer_tail];
  1133. #endif
  1134. #if HAS_FAN
  1135. FANS_LOOP(i)
  1136. tail_fan_speed[i] = thermalManager.scaledFanSpeed(i, block->fan_speed[i]);
  1137. #endif
  1138. #if ENABLED(BARICUDA)
  1139. TERN_(HAS_HEATER_1, tail_valve_pressure = block->valve_pressure);
  1140. TERN_(HAS_HEATER_2, tail_e_to_p_pressure = block->e_to_p_pressure);
  1141. #endif
  1142. #if ANY(DISABLE_X, DISABLE_Y, DISABLE_Z, DISABLE_E)
  1143. for (uint8_t b = block_buffer_tail; b != block_buffer_head; b = next_block_index(b)) {
  1144. block_t *block = &block_buffer[b];
  1145. if (ENABLED(DISABLE_X) && block->steps.x) axis_active.x = true;
  1146. if (ENABLED(DISABLE_Y) && block->steps.y) axis_active.y = true;
  1147. if (ENABLED(DISABLE_Z) && block->steps.z) axis_active.z = true;
  1148. if (ENABLED(DISABLE_E) && block->steps.e) axis_active.e = true;
  1149. }
  1150. #endif
  1151. }
  1152. else {
  1153. TERN_(HAS_CUTTER, cutter.refresh());
  1154. #if HAS_FAN
  1155. FANS_LOOP(i)
  1156. tail_fan_speed[i] = thermalManager.scaledFanSpeed(i);
  1157. #endif
  1158. #if ENABLED(BARICUDA)
  1159. TERN_(HAS_HEATER_1, tail_valve_pressure = baricuda_valve_pressure);
  1160. TERN_(HAS_HEATER_2, tail_e_to_p_pressure = baricuda_e_to_p_pressure);
  1161. #endif
  1162. }
  1163. //
  1164. // Disable inactive axes
  1165. //
  1166. if (TERN0(DISABLE_X, !axis_active.x)) DISABLE_AXIS_X();
  1167. if (TERN0(DISABLE_Y, !axis_active.y)) DISABLE_AXIS_Y();
  1168. if (TERN0(DISABLE_Z, !axis_active.z)) DISABLE_AXIS_Z();
  1169. if (TERN0(DISABLE_E, !axis_active.e)) disable_e_steppers();
  1170. //
  1171. // Update Fan speeds
  1172. //
  1173. #if HAS_FAN
  1174. #if FAN_KICKSTART_TIME > 0
  1175. static millis_t fan_kick_end[FAN_COUNT] = { 0 };
  1176. #define KICKSTART_FAN(f) \
  1177. if (tail_fan_speed[f]) { \
  1178. millis_t ms = millis(); \
  1179. if (fan_kick_end[f] == 0) { \
  1180. fan_kick_end[f] = ms + FAN_KICKSTART_TIME; \
  1181. tail_fan_speed[f] = 255; \
  1182. } else if (PENDING(ms, fan_kick_end[f])) \
  1183. tail_fan_speed[f] = 255; \
  1184. } else fan_kick_end[f] = 0
  1185. #else
  1186. #define KICKSTART_FAN(f) NOOP
  1187. #endif
  1188. #if FAN_MIN_PWM != 0 || FAN_MAX_PWM != 255
  1189. #define CALC_FAN_SPEED(f) (tail_fan_speed[f] ? map(tail_fan_speed[f], 1, 255, FAN_MIN_PWM, FAN_MAX_PWM) : FAN_OFF_PWM)
  1190. #else
  1191. #define CALC_FAN_SPEED(f) (tail_fan_speed[f] ?: FAN_OFF_PWM)
  1192. #endif
  1193. #if ENABLED(FAN_SOFT_PWM)
  1194. #define _FAN_SET(F) thermalManager.soft_pwm_amount_fan[F] = CALC_FAN_SPEED(F);
  1195. #elif ENABLED(FAST_PWM_FAN)
  1196. #define _FAN_SET(F) set_pwm_duty(FAN##F##_PIN, CALC_FAN_SPEED(F));
  1197. #else
  1198. #define _FAN_SET(F) analogWrite(pin_t(FAN##F##_PIN), CALC_FAN_SPEED(F));
  1199. #endif
  1200. #define FAN_SET(F) do{ KICKSTART_FAN(F); _FAN_SET(F); }while(0)
  1201. TERN_(HAS_FAN0, FAN_SET(0));
  1202. TERN_(HAS_FAN1, FAN_SET(1));
  1203. TERN_(HAS_FAN2, FAN_SET(2));
  1204. TERN_(HAS_FAN3, FAN_SET(3));
  1205. TERN_(HAS_FAN4, FAN_SET(4));
  1206. TERN_(HAS_FAN5, FAN_SET(5));
  1207. TERN_(HAS_FAN6, FAN_SET(6));
  1208. TERN_(HAS_FAN7, FAN_SET(7));
  1209. #endif // HAS_FAN
  1210. TERN_(AUTOTEMP, getHighESpeed());
  1211. #if ENABLED(BARICUDA)
  1212. TERN_(HAS_HEATER_1, analogWrite(pin_t(HEATER_1_PIN), tail_valve_pressure));
  1213. TERN_(HAS_HEATER_2, analogWrite(pin_t(HEATER_2_PIN), tail_e_to_p_pressure));
  1214. #endif
  1215. }
  1216. #if DISABLED(NO_VOLUMETRICS)
  1217. /**
  1218. * Get a volumetric multiplier from a filament diameter.
  1219. * This is the reciprocal of the circular cross-section area.
  1220. * Return 1.0 with volumetric off or a diameter of 0.0.
  1221. */
  1222. inline float calculate_volumetric_multiplier(const float &diameter) {
  1223. return (parser.volumetric_enabled && diameter) ? 1.0f / CIRCLE_AREA(diameter * 0.5f) : 1;
  1224. }
  1225. /**
  1226. * Convert the filament sizes into volumetric multipliers.
  1227. * The multiplier converts a given E value into a length.
  1228. */
  1229. void Planner::calculate_volumetric_multipliers() {
  1230. LOOP_L_N(i, COUNT(filament_size)) {
  1231. volumetric_multiplier[i] = calculate_volumetric_multiplier(filament_size[i]);
  1232. refresh_e_factor(i);
  1233. }
  1234. #if ENABLED(VOLUMETRIC_EXTRUDER_LIMIT)
  1235. calculate_volumetric_extruder_limits(); // update volumetric_extruder_limits as well.
  1236. #endif
  1237. }
  1238. #endif // !NO_VOLUMETRICS
  1239. #if ENABLED(VOLUMETRIC_EXTRUDER_LIMIT)
  1240. /**
  1241. * Convert volumetric based limits into pre calculated extruder feedrate limits.
  1242. */
  1243. void Planner::calculate_volumetric_extruder_limit(const uint8_t e) {
  1244. const float &lim = volumetric_extruder_limit[e], &siz = filament_size[e];
  1245. volumetric_extruder_feedrate_limit[e] = (lim && siz) ? lim / CIRCLE_AREA(siz * 0.5f) : 0;
  1246. }
  1247. void Planner::calculate_volumetric_extruder_limits() {
  1248. LOOP_L_N(e, EXTRUDERS) calculate_volumetric_extruder_limit(e);
  1249. }
  1250. #endif
  1251. #if ENABLED(FILAMENT_WIDTH_SENSOR)
  1252. /**
  1253. * Convert the ratio value given by the filament width sensor
  1254. * into a volumetric multiplier. Conversion differs when using
  1255. * linear extrusion vs volumetric extrusion.
  1256. */
  1257. void Planner::apply_filament_width_sensor(const int8_t encoded_ratio) {
  1258. // Reconstitute the nominal/measured ratio
  1259. const float nom_meas_ratio = 1 + 0.01f * encoded_ratio,
  1260. ratio_2 = sq(nom_meas_ratio);
  1261. volumetric_multiplier[FILAMENT_SENSOR_EXTRUDER_NUM] = parser.volumetric_enabled
  1262. ? ratio_2 / CIRCLE_AREA(filwidth.nominal_mm * 0.5f) // Volumetric uses a true volumetric multiplier
  1263. : ratio_2; // Linear squares the ratio, which scales the volume
  1264. refresh_e_factor(FILAMENT_SENSOR_EXTRUDER_NUM);
  1265. }
  1266. #endif
  1267. #if HAS_LEVELING
  1268. constexpr xy_pos_t level_fulcrum = {
  1269. TERN(Z_SAFE_HOMING, Z_SAFE_HOMING_X_POINT, X_HOME_POS),
  1270. TERN(Z_SAFE_HOMING, Z_SAFE_HOMING_Y_POINT, Y_HOME_POS)
  1271. };
  1272. /**
  1273. * rx, ry, rz - Cartesian positions in mm
  1274. * Leveled XYZ on completion
  1275. */
  1276. void Planner::apply_leveling(xyz_pos_t &raw) {
  1277. if (!leveling_active) return;
  1278. #if ABL_PLANAR
  1279. xy_pos_t d = raw - level_fulcrum;
  1280. apply_rotation_xyz(bed_level_matrix, d.x, d.y, raw.z);
  1281. raw = d + level_fulcrum;
  1282. #elif HAS_MESH
  1283. #if ENABLED(ENABLE_LEVELING_FADE_HEIGHT)
  1284. const float fade_scaling_factor = fade_scaling_factor_for_z(raw.z);
  1285. #elif DISABLED(MESH_BED_LEVELING)
  1286. constexpr float fade_scaling_factor = 1.0;
  1287. #endif
  1288. raw.z += (
  1289. #if ENABLED(MESH_BED_LEVELING)
  1290. mbl.get_z(raw
  1291. #if ENABLED(ENABLE_LEVELING_FADE_HEIGHT)
  1292. , fade_scaling_factor
  1293. #endif
  1294. )
  1295. #elif ENABLED(AUTO_BED_LEVELING_UBL)
  1296. fade_scaling_factor ? fade_scaling_factor * ubl.get_z_correction(raw) : 0.0
  1297. #elif ENABLED(AUTO_BED_LEVELING_BILINEAR)
  1298. fade_scaling_factor ? fade_scaling_factor * bilinear_z_offset(raw) : 0.0
  1299. #endif
  1300. );
  1301. #endif
  1302. }
  1303. void Planner::unapply_leveling(xyz_pos_t &raw) {
  1304. if (leveling_active) {
  1305. #if ABL_PLANAR
  1306. matrix_3x3 inverse = matrix_3x3::transpose(bed_level_matrix);
  1307. xy_pos_t d = raw - level_fulcrum;
  1308. apply_rotation_xyz(inverse, d.x, d.y, raw.z);
  1309. raw = d + level_fulcrum;
  1310. #elif HAS_MESH
  1311. #if ENABLED(ENABLE_LEVELING_FADE_HEIGHT)
  1312. const float fade_scaling_factor = fade_scaling_factor_for_z(raw.z);
  1313. #elif DISABLED(MESH_BED_LEVELING)
  1314. constexpr float fade_scaling_factor = 1.0;
  1315. #endif
  1316. raw.z -= (
  1317. #if ENABLED(MESH_BED_LEVELING)
  1318. mbl.get_z(raw
  1319. #if ENABLED(ENABLE_LEVELING_FADE_HEIGHT)
  1320. , fade_scaling_factor
  1321. #endif
  1322. )
  1323. #elif ENABLED(AUTO_BED_LEVELING_UBL)
  1324. fade_scaling_factor ? fade_scaling_factor * ubl.get_z_correction(raw) : 0.0
  1325. #elif ENABLED(AUTO_BED_LEVELING_BILINEAR)
  1326. fade_scaling_factor ? fade_scaling_factor * bilinear_z_offset(raw) : 0.0
  1327. #endif
  1328. );
  1329. #endif
  1330. }
  1331. }
  1332. #endif // HAS_LEVELING
  1333. #if ENABLED(FWRETRACT)
  1334. /**
  1335. * rz, e - Cartesian positions in mm
  1336. */
  1337. void Planner::apply_retract(float &rz, float &e) {
  1338. rz += fwretract.current_hop;
  1339. e -= fwretract.current_retract[active_extruder];
  1340. }
  1341. void Planner::unapply_retract(float &rz, float &e) {
  1342. rz -= fwretract.current_hop;
  1343. e += fwretract.current_retract[active_extruder];
  1344. }
  1345. #endif
  1346. void Planner::quick_stop() {
  1347. // Remove all the queued blocks. Note that this function is NOT
  1348. // called from the Stepper ISR, so we must consider tail as readonly!
  1349. // that is why we set head to tail - But there is a race condition that
  1350. // must be handled: The tail could change between the read and the assignment
  1351. // so this must be enclosed in a critical section
  1352. const bool was_enabled = stepper.suspend();
  1353. // Drop all queue entries
  1354. block_buffer_nonbusy = block_buffer_planned = block_buffer_head = block_buffer_tail;
  1355. // Restart the block delay for the first movement - As the queue was
  1356. // forced to empty, there's no risk the ISR will touch this.
  1357. delay_before_delivering = BLOCK_DELAY_FOR_1ST_MOVE;
  1358. #if HAS_WIRED_LCD
  1359. // Clear the accumulated runtime
  1360. clear_block_buffer_runtime();
  1361. #endif
  1362. // Make sure to drop any attempt of queuing moves for 1 second
  1363. cleaning_buffer_counter = TEMP_TIMER_FREQUENCY;
  1364. // Reenable Stepper ISR
  1365. if (was_enabled) stepper.wake_up();
  1366. // And stop the stepper ISR
  1367. stepper.quick_stop();
  1368. }
  1369. void Planner::endstop_triggered(const AxisEnum axis) {
  1370. // Record stepper position and discard the current block
  1371. stepper.endstop_triggered(axis);
  1372. }
  1373. float Planner::triggered_position_mm(const AxisEnum axis) {
  1374. return stepper.triggered_position(axis) * steps_to_mm[axis];
  1375. }
  1376. void Planner::finish_and_disable() {
  1377. while (has_blocks_queued() || cleaning_buffer_counter) idle();
  1378. disable_all_steppers();
  1379. }
  1380. /**
  1381. * Get an axis position according to stepper position(s)
  1382. * For CORE machines apply translation from ABC to XYZ.
  1383. */
  1384. float Planner::get_axis_position_mm(const AxisEnum axis) {
  1385. float axis_steps;
  1386. #if IS_CORE
  1387. // Requesting one of the "core" axes?
  1388. if (axis == CORE_AXIS_1 || axis == CORE_AXIS_2) {
  1389. // Protect the access to the position.
  1390. const bool was_enabled = stepper.suspend();
  1391. const int32_t p1 = stepper.position(CORE_AXIS_1),
  1392. p2 = stepper.position(CORE_AXIS_2);
  1393. if (was_enabled) stepper.wake_up();
  1394. // ((a1+a2)+(a1-a2))/2 -> (a1+a2+a1-a2)/2 -> (a1+a1)/2 -> a1
  1395. // ((a1+a2)-(a1-a2))/2 -> (a1+a2-a1+a2)/2 -> (a2+a2)/2 -> a2
  1396. axis_steps = (axis == CORE_AXIS_2 ? CORESIGN(p1 - p2) : p1 + p2) * 0.5f;
  1397. }
  1398. else
  1399. axis_steps = stepper.position(axis);
  1400. #elif ENABLED(MARKFORGED_XY)
  1401. // Requesting one of the joined axes?
  1402. if (axis == CORE_AXIS_1 || axis == CORE_AXIS_2) {
  1403. // Protect the access to the position.
  1404. const bool was_enabled = stepper.suspend();
  1405. const int32_t p1 = stepper.position(CORE_AXIS_1),
  1406. p2 = stepper.position(CORE_AXIS_2);
  1407. if (was_enabled) stepper.wake_up();
  1408. axis_steps = ((axis == CORE_AXIS_1) ? p1 - p2 : p2);
  1409. }
  1410. else
  1411. axis_steps = stepper.position(axis);
  1412. #else
  1413. axis_steps = stepper.position(axis);
  1414. #endif
  1415. return axis_steps * steps_to_mm[axis];
  1416. }
  1417. /**
  1418. * Block until all buffered steps are executed / cleaned
  1419. */
  1420. void Planner::synchronize() {
  1421. while (has_blocks_queued() || cleaning_buffer_counter
  1422. || TERN0(EXTERNAL_CLOSED_LOOP_CONTROLLER, CLOSED_LOOP_WAITING())
  1423. ) idle();
  1424. }
  1425. /**
  1426. * Planner::_buffer_steps
  1427. *
  1428. * Add a new linear movement to the planner queue (in terms of steps).
  1429. *
  1430. * target - target position in steps units
  1431. * target_float - target position in direct (mm, degrees) units. optional
  1432. * fr_mm_s - (target) speed of the move
  1433. * extruder - target extruder
  1434. * millimeters - the length of the movement, if known
  1435. *
  1436. * Returns true if movement was properly queued, false otherwise (if cleaning)
  1437. */
  1438. bool Planner::_buffer_steps(const xyze_long_t &target
  1439. #if HAS_POSITION_FLOAT
  1440. , const xyze_pos_t &target_float
  1441. #endif
  1442. #if HAS_DIST_MM_ARG
  1443. , const xyze_float_t &cart_dist_mm
  1444. #endif
  1445. , feedRate_t fr_mm_s, const uint8_t extruder, const float &millimeters
  1446. ) {
  1447. // If we are cleaning, do not accept queuing of movements
  1448. if (cleaning_buffer_counter) return false;
  1449. // Wait for the next available block
  1450. uint8_t next_buffer_head;
  1451. block_t * const block = get_next_free_block(next_buffer_head);
  1452. // Fill the block with the specified movement
  1453. if (!_populate_block(block, false, target
  1454. #if HAS_POSITION_FLOAT
  1455. , target_float
  1456. #endif
  1457. #if HAS_DIST_MM_ARG
  1458. , cart_dist_mm
  1459. #endif
  1460. , fr_mm_s, extruder, millimeters
  1461. )) {
  1462. // Movement was not queued, probably because it was too short.
  1463. // Simply accept that as movement queued and done
  1464. return true;
  1465. }
  1466. // If this is the first added movement, reload the delay, otherwise, cancel it.
  1467. if (block_buffer_head == block_buffer_tail) {
  1468. // If it was the first queued block, restart the 1st block delivery delay, to
  1469. // give the planner an opportunity to queue more movements and plan them
  1470. // As there are no queued movements, the Stepper ISR will not touch this
  1471. // variable, so there is no risk setting this here (but it MUST be done
  1472. // before the following line!!)
  1473. delay_before_delivering = BLOCK_DELAY_FOR_1ST_MOVE;
  1474. }
  1475. // Move buffer head
  1476. block_buffer_head = next_buffer_head;
  1477. // Recalculate and optimize trapezoidal speed profiles
  1478. recalculate();
  1479. // Movement successfully queued!
  1480. return true;
  1481. }
  1482. /**
  1483. * Planner::_populate_block
  1484. *
  1485. * Fills a new linear movement in the block (in terms of steps).
  1486. *
  1487. * target - target position in steps units
  1488. * fr_mm_s - (target) speed of the move
  1489. * extruder - target extruder
  1490. *
  1491. * Returns true if movement is acceptable, false otherwise
  1492. */
  1493. bool Planner::_populate_block(block_t * const block, bool split_move,
  1494. const abce_long_t &target
  1495. #if HAS_POSITION_FLOAT
  1496. , const xyze_pos_t &target_float
  1497. #endif
  1498. #if HAS_DIST_MM_ARG
  1499. , const xyze_float_t &cart_dist_mm
  1500. #endif
  1501. , feedRate_t fr_mm_s, const uint8_t extruder, const float &millimeters/*=0.0*/
  1502. ) {
  1503. const int32_t da = target.a - position.a,
  1504. db = target.b - position.b,
  1505. dc = target.c - position.c;
  1506. #if EXTRUDERS
  1507. int32_t de = target.e - position.e;
  1508. #else
  1509. constexpr int32_t de = 0;
  1510. #endif
  1511. /* <-- add a slash to enable
  1512. SERIAL_ECHOLNPAIR(" _populate_block FR:", fr_mm_s,
  1513. " A:", target.a, " (", da, " steps)"
  1514. " B:", target.b, " (", db, " steps)"
  1515. " C:", target.c, " (", dc, " steps)"
  1516. #if EXTRUDERS
  1517. " E:", target.e, " (", de, " steps)"
  1518. #endif
  1519. );
  1520. //*/
  1521. #if EITHER(PREVENT_COLD_EXTRUSION, PREVENT_LENGTHY_EXTRUDE)
  1522. if (de) {
  1523. #if ENABLED(PREVENT_COLD_EXTRUSION)
  1524. if (thermalManager.tooColdToExtrude(extruder)) {
  1525. position.e = target.e; // Behave as if the move really took place, but ignore E part
  1526. TERN_(HAS_POSITION_FLOAT, position_float.e = target_float.e);
  1527. de = 0; // no difference
  1528. SERIAL_ECHO_MSG(STR_ERR_COLD_EXTRUDE_STOP);
  1529. }
  1530. #endif // PREVENT_COLD_EXTRUSION
  1531. #if ENABLED(PREVENT_LENGTHY_EXTRUDE)
  1532. const float e_steps = ABS(de * e_factor[extruder]);
  1533. const float max_e_steps = settings.axis_steps_per_mm[E_AXIS_N(extruder)] * (EXTRUDE_MAXLENGTH);
  1534. if (e_steps > max_e_steps) {
  1535. #if ENABLED(MIXING_EXTRUDER)
  1536. bool ignore_e = false;
  1537. float collector[MIXING_STEPPERS];
  1538. mixer.refresh_collector(1.0, mixer.get_current_vtool(), collector);
  1539. MIXER_STEPPER_LOOP(e)
  1540. if (e_steps * collector[e] > max_e_steps) { ignore_e = true; break; }
  1541. #else
  1542. constexpr bool ignore_e = true;
  1543. #endif
  1544. if (ignore_e) {
  1545. position.e = target.e; // Behave as if the move really took place, but ignore E part
  1546. TERN_(HAS_POSITION_FLOAT, position_float.e = target_float.e);
  1547. de = 0; // no difference
  1548. SERIAL_ECHO_MSG(STR_ERR_LONG_EXTRUDE_STOP);
  1549. }
  1550. }
  1551. #endif // PREVENT_LENGTHY_EXTRUDE
  1552. }
  1553. #endif // PREVENT_COLD_EXTRUSION || PREVENT_LENGTHY_EXTRUDE
  1554. // Compute direction bit-mask for this block
  1555. uint8_t dm = 0;
  1556. #if CORE_IS_XY
  1557. if (da < 0) SBI(dm, X_HEAD); // Save the real Extruder (head) direction in X Axis
  1558. if (db < 0) SBI(dm, Y_HEAD); // ...and Y
  1559. if (dc < 0) SBI(dm, Z_AXIS);
  1560. if (da + db < 0) SBI(dm, A_AXIS); // Motor A direction
  1561. if (CORESIGN(da - db) < 0) SBI(dm, B_AXIS); // Motor B direction
  1562. #elif CORE_IS_XZ
  1563. if (da < 0) SBI(dm, X_HEAD); // Save the real Extruder (head) direction in X Axis
  1564. if (db < 0) SBI(dm, Y_AXIS);
  1565. if (dc < 0) SBI(dm, Z_HEAD); // ...and Z
  1566. if (da + dc < 0) SBI(dm, A_AXIS); // Motor A direction
  1567. if (CORESIGN(da - dc) < 0) SBI(dm, C_AXIS); // Motor C direction
  1568. #elif CORE_IS_YZ
  1569. if (da < 0) SBI(dm, X_AXIS);
  1570. if (db < 0) SBI(dm, Y_HEAD); // Save the real Extruder (head) direction in Y Axis
  1571. if (dc < 0) SBI(dm, Z_HEAD); // ...and Z
  1572. if (db + dc < 0) SBI(dm, B_AXIS); // Motor B direction
  1573. if (CORESIGN(db - dc) < 0) SBI(dm, C_AXIS); // Motor C direction
  1574. #elif ENABLED(MARKFORGED_XY)
  1575. if (da < 0) SBI(dm, X_HEAD); // Save the real Extruder (head) direction in X Axis
  1576. if (db < 0) SBI(dm, Y_HEAD); // ...and Y
  1577. if (dc < 0) SBI(dm, Z_AXIS);
  1578. if (da + db < 0) SBI(dm, A_AXIS); // Motor A direction
  1579. if (db < 0) SBI(dm, B_AXIS); // Motor B direction
  1580. #else
  1581. if (da < 0) SBI(dm, X_AXIS);
  1582. if (db < 0) SBI(dm, Y_AXIS);
  1583. if (dc < 0) SBI(dm, Z_AXIS);
  1584. #endif
  1585. if (de < 0) SBI(dm, E_AXIS);
  1586. #if EXTRUDERS
  1587. const float esteps_float = de * e_factor[extruder];
  1588. const uint32_t esteps = ABS(esteps_float) + 0.5f;
  1589. #else
  1590. constexpr uint32_t esteps = 0;
  1591. #endif
  1592. // Clear all flags, including the "busy" bit
  1593. block->flag = 0x00;
  1594. // Set direction bits
  1595. block->direction_bits = dm;
  1596. // Update block laser power
  1597. #if ENABLED(LASER_POWER_INLINE)
  1598. laser_inline.status.isPlanned = true;
  1599. block->laser.status = laser_inline.status;
  1600. block->laser.power = laser_inline.power;
  1601. #endif
  1602. // Number of steps for each axis
  1603. // See https://www.corexy.com/theory.html
  1604. #if CORE_IS_XY
  1605. block->steps.set(ABS(da + db), ABS(da - db), ABS(dc));
  1606. #elif CORE_IS_XZ
  1607. block->steps.set(ABS(da + dc), ABS(db), ABS(da - dc));
  1608. #elif CORE_IS_YZ
  1609. block->steps.set(ABS(da), ABS(db + dc), ABS(db - dc));
  1610. #elif ENABLED(MARKFORGED_XY)
  1611. block->steps.set(ABS(da + db), ABS(db), ABS(dc));
  1612. #elif IS_SCARA
  1613. block->steps.set(ABS(da), ABS(db), ABS(dc));
  1614. #else
  1615. // default non-h-bot planning
  1616. block->steps.set(ABS(da), ABS(db), ABS(dc));
  1617. #endif
  1618. /**
  1619. * This part of the code calculates the total length of the movement.
  1620. * For cartesian bots, the X_AXIS is the real X movement and same for Y_AXIS.
  1621. * But for corexy bots, that is not true. The "X_AXIS" and "Y_AXIS" motors (that should be named to A_AXIS
  1622. * and B_AXIS) cannot be used for X and Y length, because A=X+Y and B=X-Y.
  1623. * So we need to create other 2 "AXIS", named X_HEAD and Y_HEAD, meaning the real displacement of the Head.
  1624. * Having the real displacement of the head, we can calculate the total movement length and apply the desired speed.
  1625. */
  1626. struct DistanceMM : abce_float_t {
  1627. #if EITHER(IS_CORE, MARKFORGED_XY)
  1628. xyz_pos_t head;
  1629. #endif
  1630. } steps_dist_mm;
  1631. #if IS_CORE
  1632. #if CORE_IS_XY
  1633. steps_dist_mm.head.x = da * steps_to_mm[A_AXIS];
  1634. steps_dist_mm.head.y = db * steps_to_mm[B_AXIS];
  1635. steps_dist_mm.z = dc * steps_to_mm[Z_AXIS];
  1636. steps_dist_mm.a = (da + db) * steps_to_mm[A_AXIS];
  1637. steps_dist_mm.b = CORESIGN(da - db) * steps_to_mm[B_AXIS];
  1638. #elif CORE_IS_XZ
  1639. steps_dist_mm.head.x = da * steps_to_mm[A_AXIS];
  1640. steps_dist_mm.y = db * steps_to_mm[Y_AXIS];
  1641. steps_dist_mm.head.z = dc * steps_to_mm[C_AXIS];
  1642. steps_dist_mm.a = (da + dc) * steps_to_mm[A_AXIS];
  1643. steps_dist_mm.c = CORESIGN(da - dc) * steps_to_mm[C_AXIS];
  1644. #elif CORE_IS_YZ
  1645. steps_dist_mm.x = da * steps_to_mm[X_AXIS];
  1646. steps_dist_mm.head.y = db * steps_to_mm[B_AXIS];
  1647. steps_dist_mm.head.z = dc * steps_to_mm[C_AXIS];
  1648. steps_dist_mm.b = (db + dc) * steps_to_mm[B_AXIS];
  1649. steps_dist_mm.c = CORESIGN(db - dc) * steps_to_mm[C_AXIS];
  1650. #endif
  1651. #elif ENABLED(MARKFORGED_XY)
  1652. steps_dist_mm.head.x = da * steps_to_mm[A_AXIS];
  1653. steps_dist_mm.head.y = db * steps_to_mm[B_AXIS];
  1654. steps_dist_mm.z = dc * steps_to_mm[Z_AXIS];
  1655. steps_dist_mm.a = (da - db) * steps_to_mm[A_AXIS];
  1656. steps_dist_mm.b = db * steps_to_mm[B_AXIS];
  1657. #else
  1658. steps_dist_mm.a = da * steps_to_mm[A_AXIS];
  1659. steps_dist_mm.b = db * steps_to_mm[B_AXIS];
  1660. steps_dist_mm.c = dc * steps_to_mm[C_AXIS];
  1661. #endif
  1662. #if EXTRUDERS
  1663. steps_dist_mm.e = esteps_float * steps_to_mm[E_AXIS_N(extruder)];
  1664. #else
  1665. steps_dist_mm.e = 0.0f;
  1666. #endif
  1667. TERN_(LCD_SHOW_E_TOTAL, e_move_accumulator += steps_dist_mm.e);
  1668. if (block->steps.a < MIN_STEPS_PER_SEGMENT && block->steps.b < MIN_STEPS_PER_SEGMENT && block->steps.c < MIN_STEPS_PER_SEGMENT) {
  1669. block->millimeters = (0
  1670. #if EXTRUDERS
  1671. + ABS(steps_dist_mm.e)
  1672. #endif
  1673. );
  1674. }
  1675. else {
  1676. if (millimeters)
  1677. block->millimeters = millimeters;
  1678. else
  1679. block->millimeters = SQRT(
  1680. #if EITHER(CORE_IS_XY, MARKFORGED_XY)
  1681. sq(steps_dist_mm.head.x) + sq(steps_dist_mm.head.y) + sq(steps_dist_mm.z)
  1682. #elif CORE_IS_XZ
  1683. sq(steps_dist_mm.head.x) + sq(steps_dist_mm.y) + sq(steps_dist_mm.head.z)
  1684. #elif CORE_IS_YZ
  1685. sq(steps_dist_mm.x) + sq(steps_dist_mm.head.y) + sq(steps_dist_mm.head.z)
  1686. #else
  1687. sq(steps_dist_mm.x) + sq(steps_dist_mm.y) + sq(steps_dist_mm.z)
  1688. #endif
  1689. );
  1690. /**
  1691. * At this point at least one of the axes has more steps than
  1692. * MIN_STEPS_PER_SEGMENT, ensuring the segment won't get dropped as
  1693. * zero-length. It's important to not apply corrections
  1694. * to blocks that would get dropped!
  1695. *
  1696. * A correction function is permitted to add steps to an axis, it
  1697. * should *never* remove steps!
  1698. */
  1699. TERN_(BACKLASH_COMPENSATION, backlash.add_correction_steps(da, db, dc, dm, block));
  1700. }
  1701. #if EXTRUDERS
  1702. block->steps.e = esteps;
  1703. #endif
  1704. block->step_event_count = _MAX(block->steps.a, block->steps.b, block->steps.c, esteps);
  1705. // Bail if this is a zero-length block
  1706. if (block->step_event_count < MIN_STEPS_PER_SEGMENT) return false;
  1707. #if ENABLED(MIXING_EXTRUDER)
  1708. MIXER_POPULATE_BLOCK();
  1709. #endif
  1710. TERN_(HAS_CUTTER, block->cutter_power = cutter.power);
  1711. #if HAS_FAN
  1712. FANS_LOOP(i) block->fan_speed[i] = thermalManager.fan_speed[i];
  1713. #endif
  1714. #if ENABLED(BARICUDA)
  1715. block->valve_pressure = baricuda_valve_pressure;
  1716. block->e_to_p_pressure = baricuda_e_to_p_pressure;
  1717. #endif
  1718. #if HAS_MULTI_EXTRUDER
  1719. block->extruder = extruder;
  1720. #endif
  1721. #if ENABLED(AUTO_POWER_CONTROL)
  1722. if (block->steps.x || block->steps.y || block->steps.z)
  1723. powerManager.power_on();
  1724. #endif
  1725. // Enable active axes
  1726. #if EITHER(CORE_IS_XY, MARKFORGED_XY)
  1727. if (block->steps.a || block->steps.b) {
  1728. ENABLE_AXIS_X();
  1729. ENABLE_AXIS_Y();
  1730. }
  1731. #if DISABLED(Z_LATE_ENABLE)
  1732. if (block->steps.z) ENABLE_AXIS_Z();
  1733. #endif
  1734. #elif CORE_IS_XZ
  1735. if (block->steps.a || block->steps.c) {
  1736. ENABLE_AXIS_X();
  1737. ENABLE_AXIS_Z();
  1738. }
  1739. if (block->steps.y) ENABLE_AXIS_Y();
  1740. #elif CORE_IS_YZ
  1741. if (block->steps.b || block->steps.c) {
  1742. ENABLE_AXIS_Y();
  1743. ENABLE_AXIS_Z();
  1744. }
  1745. if (block->steps.x) ENABLE_AXIS_X();
  1746. #else
  1747. if (block->steps.x) ENABLE_AXIS_X();
  1748. if (block->steps.y) ENABLE_AXIS_Y();
  1749. #if DISABLED(Z_LATE_ENABLE)
  1750. if (block->steps.z) ENABLE_AXIS_Z();
  1751. #endif
  1752. #endif
  1753. // Enable extruder(s)
  1754. #if EXTRUDERS
  1755. if (esteps) {
  1756. TERN_(AUTO_POWER_CONTROL, powerManager.power_on());
  1757. #if ENABLED(DISABLE_INACTIVE_EXTRUDER) // Enable only the selected extruder
  1758. LOOP_L_N(i, EXTRUDERS)
  1759. if (g_uc_extruder_last_move[i] > 0) g_uc_extruder_last_move[i]--;
  1760. #if HAS_DUPLICATION_MODE
  1761. if (extruder_duplication_enabled && extruder == 0) {
  1762. ENABLE_AXIS_E1();
  1763. g_uc_extruder_last_move[1] = (BLOCK_BUFFER_SIZE) * 2;
  1764. }
  1765. #endif
  1766. #define ENABLE_ONE_E(N) do{ \
  1767. if (extruder == N) { \
  1768. ENABLE_AXIS_E##N(); \
  1769. g_uc_extruder_last_move[N] = (BLOCK_BUFFER_SIZE) * 2; \
  1770. } \
  1771. else if (!g_uc_extruder_last_move[N]) \
  1772. DISABLE_AXIS_E##N(); \
  1773. }while(0);
  1774. #else
  1775. #define ENABLE_ONE_E(N) ENABLE_AXIS_E##N();
  1776. #endif
  1777. REPEAT(EXTRUDERS, ENABLE_ONE_E); // (ENABLE_ONE_E must end with semicolon)
  1778. }
  1779. #endif // EXTRUDERS
  1780. if (esteps)
  1781. NOLESS(fr_mm_s, settings.min_feedrate_mm_s);
  1782. else
  1783. NOLESS(fr_mm_s, settings.min_travel_feedrate_mm_s);
  1784. const float inverse_millimeters = 1.0f / block->millimeters; // Inverse millimeters to remove multiple divides
  1785. // Calculate inverse time for this move. No divide by zero due to previous checks.
  1786. // Example: At 120mm/s a 60mm move takes 0.5s. So this will give 2.0.
  1787. float inverse_secs = fr_mm_s * inverse_millimeters;
  1788. // Get the number of non busy movements in queue (non busy means that they can be altered)
  1789. const uint8_t moves_queued = nonbusy_movesplanned();
  1790. // Slow down when the buffer starts to empty, rather than wait at the corner for a buffer refill
  1791. #if EITHER(SLOWDOWN, HAS_WIRED_LCD) || defined(XY_FREQUENCY_LIMIT)
  1792. // Segment time im micro seconds
  1793. int32_t segment_time_us = LROUND(1000000.0f / inverse_secs);
  1794. #endif
  1795. #if ENABLED(SLOWDOWN)
  1796. #ifndef SLOWDOWN_DIVISOR
  1797. #define SLOWDOWN_DIVISOR 2
  1798. #endif
  1799. if (WITHIN(moves_queued, 2, (BLOCK_BUFFER_SIZE) / (SLOWDOWN_DIVISOR) - 1)) {
  1800. const int32_t time_diff = settings.min_segment_time_us - segment_time_us;
  1801. if (time_diff > 0) {
  1802. // Buffer is draining so add extra time. The amount of time added increases if the buffer is still emptied more.
  1803. const int32_t nst = segment_time_us + LROUND(2 * time_diff / moves_queued);
  1804. inverse_secs = 1000000.0f / nst;
  1805. #if defined(XY_FREQUENCY_LIMIT) || HAS_WIRED_LCD
  1806. segment_time_us = nst;
  1807. #endif
  1808. }
  1809. }
  1810. #endif
  1811. #if HAS_WIRED_LCD
  1812. // Protect the access to the position.
  1813. const bool was_enabled = stepper.suspend();
  1814. block_buffer_runtime_us += segment_time_us;
  1815. block->segment_time_us = segment_time_us;
  1816. if (was_enabled) stepper.wake_up();
  1817. #endif
  1818. block->nominal_speed_sqr = sq(block->millimeters * inverse_secs); // (mm/sec)^2 Always > 0
  1819. block->nominal_rate = CEIL(block->step_event_count * inverse_secs); // (step/sec) Always > 0
  1820. #if ENABLED(FILAMENT_WIDTH_SENSOR)
  1821. if (extruder == FILAMENT_SENSOR_EXTRUDER_NUM) // Only for extruder with filament sensor
  1822. filwidth.advance_e(steps_dist_mm.e);
  1823. #endif
  1824. // Calculate and limit speed in mm/sec
  1825. xyze_float_t current_speed;
  1826. float speed_factor = 1.0f; // factor <1 decreases speed
  1827. // Linear axes first with less logic
  1828. LOOP_XYZ(i) {
  1829. current_speed[i] = steps_dist_mm[i] * inverse_secs;
  1830. const feedRate_t cs = ABS(current_speed[i]),
  1831. max_fr = settings.max_feedrate_mm_s[i];
  1832. if (cs > max_fr) NOMORE(speed_factor, max_fr / cs);
  1833. }
  1834. // Limit speed on extruders, if any
  1835. #if EXTRUDERS
  1836. {
  1837. current_speed.e = steps_dist_mm.e * inverse_secs;
  1838. #if HAS_MIXER_SYNC_CHANNEL
  1839. // Move all mixing extruders at the specified rate
  1840. if (mixer.get_current_vtool() == MIXER_AUTORETRACT_TOOL)
  1841. current_speed.e *= MIXING_STEPPERS;
  1842. #endif
  1843. const feedRate_t cs = ABS(current_speed.e),
  1844. max_fr = settings.max_feedrate_mm_s[E_AXIS_N(extruder)]
  1845. * TERN(HAS_MIXER_SYNC_CHANNEL, MIXING_STEPPERS, 1);
  1846. if (cs > max_fr) NOMORE(speed_factor, max_fr / cs); //respect max feedrate on any movement (doesn't matter if E axes only or not)
  1847. #if ENABLED(VOLUMETRIC_EXTRUDER_LIMIT)
  1848. const feedRate_t max_vfr = volumetric_extruder_feedrate_limit[extruder]
  1849. * TERN(HAS_MIXER_SYNC_CHANNEL, MIXING_STEPPERS, 1);
  1850. // TODO: Doesn't work properly for joined segments. Set MIN_STEPS_PER_SEGMENT 1 as workaround.
  1851. if (block->steps.a || block->steps.b || block->steps.c) {
  1852. if (max_vfr > 0 && cs > max_vfr) {
  1853. NOMORE(speed_factor, max_vfr / cs); // respect volumetric extruder limit (if any)
  1854. /* <-- add a slash to enable
  1855. SERIAL_ECHOPAIR("volumetric extruder limit enforced: ", (cs * CIRCLE_AREA(filament_size[extruder] * 0.5f)));
  1856. SERIAL_ECHOPAIR(" mm^3/s (", cs);
  1857. SERIAL_ECHOPAIR(" mm/s) limited to ", (max_vfr * CIRCLE_AREA(filament_size[extruder] * 0.5f)));
  1858. SERIAL_ECHOPAIR(" mm^3/s (", max_vfr);
  1859. SERIAL_ECHOLNPGM(" mm/s)");
  1860. //*/
  1861. }
  1862. }
  1863. #endif
  1864. }
  1865. #endif
  1866. #ifdef XY_FREQUENCY_LIMIT
  1867. static uint8_t old_direction_bits; // = 0
  1868. if (xy_freq_limit_hz) {
  1869. // Check and limit the xy direction change frequency
  1870. const uint8_t direction_change = block->direction_bits ^ old_direction_bits;
  1871. old_direction_bits = block->direction_bits;
  1872. segment_time_us = LROUND(float(segment_time_us) / speed_factor);
  1873. static int32_t xs0, xs1, xs2, ys0, ys1, ys2;
  1874. if (segment_time_us > xy_freq_min_interval_us)
  1875. xs2 = xs1 = ys2 = ys1 = xy_freq_min_interval_us;
  1876. else {
  1877. xs2 = xs1; xs1 = xs0;
  1878. ys2 = ys1; ys1 = ys0;
  1879. }
  1880. xs0 = TEST(direction_change, X_AXIS) ? segment_time_us : xy_freq_min_interval_us;
  1881. ys0 = TEST(direction_change, Y_AXIS) ? segment_time_us : xy_freq_min_interval_us;
  1882. if (segment_time_us < xy_freq_min_interval_us) {
  1883. const int32_t least_xy_segment_time = _MIN(_MAX(xs0, xs1, xs2), _MAX(ys0, ys1, ys2));
  1884. if (least_xy_segment_time < xy_freq_min_interval_us) {
  1885. float freq_xy_feedrate = (speed_factor * least_xy_segment_time) / xy_freq_min_interval_us;
  1886. NOLESS(freq_xy_feedrate, xy_freq_min_speed_factor);
  1887. NOMORE(speed_factor, freq_xy_feedrate);
  1888. }
  1889. }
  1890. }
  1891. #endif // XY_FREQUENCY_LIMIT
  1892. // Correct the speed
  1893. if (speed_factor < 1.0f) {
  1894. current_speed *= speed_factor;
  1895. block->nominal_rate *= speed_factor;
  1896. block->nominal_speed_sqr = block->nominal_speed_sqr * sq(speed_factor);
  1897. }
  1898. // Compute and limit the acceleration rate for the trapezoid generator.
  1899. const float steps_per_mm = block->step_event_count * inverse_millimeters;
  1900. uint32_t accel;
  1901. if (!block->steps.a && !block->steps.b && !block->steps.c) {
  1902. // convert to: acceleration steps/sec^2
  1903. accel = CEIL(settings.retract_acceleration * steps_per_mm);
  1904. TERN_(LIN_ADVANCE, block->use_advance_lead = false);
  1905. }
  1906. else {
  1907. #define LIMIT_ACCEL_LONG(AXIS,INDX) do{ \
  1908. if (block->steps[AXIS] && max_acceleration_steps_per_s2[AXIS+INDX] < accel) { \
  1909. const uint32_t comp = max_acceleration_steps_per_s2[AXIS+INDX] * block->step_event_count; \
  1910. if (accel * block->steps[AXIS] > comp) accel = comp / block->steps[AXIS]; \
  1911. } \
  1912. }while(0)
  1913. #define LIMIT_ACCEL_FLOAT(AXIS,INDX) do{ \
  1914. if (block->steps[AXIS] && max_acceleration_steps_per_s2[AXIS+INDX] < accel) { \
  1915. const float comp = (float)max_acceleration_steps_per_s2[AXIS+INDX] * (float)block->step_event_count; \
  1916. if ((float)accel * (float)block->steps[AXIS] > comp) accel = comp / (float)block->steps[AXIS]; \
  1917. } \
  1918. }while(0)
  1919. // Start with print or travel acceleration
  1920. accel = CEIL((esteps ? settings.acceleration : settings.travel_acceleration) * steps_per_mm);
  1921. #if ENABLED(LIN_ADVANCE)
  1922. #define MAX_E_JERK(N) TERN(HAS_LINEAR_E_JERK, max_e_jerk[E_INDEX_N(N)], max_jerk.e)
  1923. /**
  1924. * Use LIN_ADVANCE for blocks if all these are true:
  1925. *
  1926. * esteps : This is a print move, because we checked for A, B, C steps before.
  1927. *
  1928. * extruder_advance_K[active_extruder] : There is an advance factor set for this extruder.
  1929. *
  1930. * de > 0 : Extruder is running forward (e.g., for "Wipe while retracting" (Slic3r) or "Combing" (Cura) moves)
  1931. */
  1932. block->use_advance_lead = esteps
  1933. && extruder_advance_K[active_extruder]
  1934. && de > 0;
  1935. if (block->use_advance_lead) {
  1936. block->e_D_ratio = (target_float.e - position_float.e) /
  1937. #if IS_KINEMATIC
  1938. block->millimeters
  1939. #else
  1940. SQRT(sq(target_float.x - position_float.x)
  1941. + sq(target_float.y - position_float.y)
  1942. + sq(target_float.z - position_float.z))
  1943. #endif
  1944. ;
  1945. // Check for unusual high e_D ratio to detect if a retract move was combined with the last print move due to min. steps per segment. Never execute this with advance!
  1946. // This assumes no one will use a retract length of 0mm < retr_length < ~0.2mm and no one will print 100mm wide lines using 3mm filament or 35mm wide lines using 1.75mm filament.
  1947. if (block->e_D_ratio > 3.0f)
  1948. block->use_advance_lead = false;
  1949. else {
  1950. const uint32_t max_accel_steps_per_s2 = MAX_E_JERK(extruder) / (extruder_advance_K[active_extruder] * block->e_D_ratio) * steps_per_mm;
  1951. if (TERN0(LA_DEBUG, accel > max_accel_steps_per_s2))
  1952. SERIAL_ECHOLNPGM("Acceleration limited.");
  1953. NOMORE(accel, max_accel_steps_per_s2);
  1954. }
  1955. }
  1956. #endif
  1957. // Limit acceleration per axis
  1958. if (block->step_event_count <= cutoff_long) {
  1959. LIMIT_ACCEL_LONG(A_AXIS, 0);
  1960. LIMIT_ACCEL_LONG(B_AXIS, 0);
  1961. LIMIT_ACCEL_LONG(C_AXIS, 0);
  1962. LIMIT_ACCEL_LONG(E_AXIS, E_INDEX_N(extruder));
  1963. }
  1964. else {
  1965. LIMIT_ACCEL_FLOAT(A_AXIS, 0);
  1966. LIMIT_ACCEL_FLOAT(B_AXIS, 0);
  1967. LIMIT_ACCEL_FLOAT(C_AXIS, 0);
  1968. LIMIT_ACCEL_FLOAT(E_AXIS, E_INDEX_N(extruder));
  1969. }
  1970. }
  1971. block->acceleration_steps_per_s2 = accel;
  1972. block->acceleration = accel / steps_per_mm;
  1973. #if DISABLED(S_CURVE_ACCELERATION)
  1974. block->acceleration_rate = (uint32_t)(accel * (4096.0f * 4096.0f / (STEPPER_TIMER_RATE)));
  1975. #endif
  1976. #if ENABLED(LIN_ADVANCE)
  1977. if (block->use_advance_lead) {
  1978. block->advance_speed = (STEPPER_TIMER_RATE) / (extruder_advance_K[active_extruder] * block->e_D_ratio * block->acceleration * settings.axis_steps_per_mm[E_AXIS_N(extruder)]);
  1979. #if ENABLED(LA_DEBUG)
  1980. if (extruder_advance_K[active_extruder] * block->e_D_ratio * block->acceleration * 2 < SQRT(block->nominal_speed_sqr) * block->e_D_ratio)
  1981. SERIAL_ECHOLNPGM("More than 2 steps per eISR loop executed.");
  1982. if (block->advance_speed < 200)
  1983. SERIAL_ECHOLNPGM("eISR running at > 10kHz.");
  1984. #endif
  1985. }
  1986. #endif
  1987. float vmax_junction_sqr; // Initial limit on the segment entry velocity (mm/s)^2
  1988. #if HAS_JUNCTION_DEVIATION
  1989. /**
  1990. * Compute maximum allowable entry speed at junction by centripetal acceleration approximation.
  1991. * Let a circle be tangent to both previous and current path line segments, where the junction
  1992. * deviation is defined as the distance from the junction to the closest edge of the circle,
  1993. * colinear with the circle center. The circular segment joining the two paths represents the
  1994. * path of centripetal acceleration. Solve for max velocity based on max acceleration about the
  1995. * radius of the circle, defined indirectly by junction deviation. This may be also viewed as
  1996. * path width or max_jerk in the previous Grbl version. This approach does not actually deviate
  1997. * from path, but used as a robust way to compute cornering speeds, as it takes into account the
  1998. * nonlinearities of both the junction angle and junction velocity.
  1999. *
  2000. * NOTE: If the junction deviation value is finite, Grbl executes the motions in an exact path
  2001. * mode (G61). If the junction deviation value is zero, Grbl will execute the motion in an exact
  2002. * stop mode (G61.1) manner. In the future, if continuous mode (G64) is desired, the math here
  2003. * is exactly the same. Instead of motioning all the way to junction point, the machine will
  2004. * just follow the arc circle defined here. The Arduino doesn't have the CPU cycles to perform
  2005. * a continuous mode path, but ARM-based microcontrollers most certainly do.
  2006. *
  2007. * NOTE: The max junction speed is a fixed value, since machine acceleration limits cannot be
  2008. * changed dynamically during operation nor can the line move geometry. This must be kept in
  2009. * memory in the event of a feedrate override changing the nominal speeds of blocks, which can
  2010. * change the overall maximum entry speed conditions of all blocks.
  2011. *
  2012. * #######
  2013. * https://github.com/MarlinFirmware/Marlin/issues/10341#issuecomment-388191754
  2014. *
  2015. * hoffbaked: on May 10 2018 tuned and improved the GRBL algorithm for Marlin:
  2016. Okay! It seems to be working good. I somewhat arbitrarily cut it off at 1mm
  2017. on then on anything with less sides than an octagon. With this, and the
  2018. reverse pass actually recalculating things, a corner acceleration value
  2019. of 1000 junction deviation of .05 are pretty reasonable. If the cycles
  2020. can be spared, a better acos could be used. For all I know, it may be
  2021. already calculated in a different place. */
  2022. // Unit vector of previous path line segment
  2023. static xyze_float_t prev_unit_vec;
  2024. xyze_float_t unit_vec =
  2025. #if HAS_DIST_MM_ARG
  2026. cart_dist_mm
  2027. #else
  2028. { steps_dist_mm.x, steps_dist_mm.y, steps_dist_mm.z, steps_dist_mm.e }
  2029. #endif
  2030. ;
  2031. /**
  2032. * On CoreXY the length of the vector [A,B] is SQRT(2) times the length of the head movement vector [X,Y].
  2033. * So taking Z and E into account, we cannot scale to a unit vector with "inverse_millimeters".
  2034. * => normalize the complete junction vector.
  2035. * Elsewise, when needed JD will factor-in the E component
  2036. */
  2037. if (EITHER(IS_CORE, MARKFORGED_XY) || esteps > 0)
  2038. normalize_junction_vector(unit_vec); // Normalize with XYZE components
  2039. else
  2040. unit_vec *= inverse_millimeters; // Use pre-calculated (1 / SQRT(x^2 + y^2 + z^2))
  2041. // Skip first block or when previous_nominal_speed is used as a flag for homing and offset cycles.
  2042. if (moves_queued && !UNEAR_ZERO(previous_nominal_speed_sqr)) {
  2043. // Compute cosine of angle between previous and current path. (prev_unit_vec is negative)
  2044. // NOTE: Max junction velocity is computed without sin() or acos() by trig half angle identity.
  2045. float junction_cos_theta = (-prev_unit_vec.x * unit_vec.x) + (-prev_unit_vec.y * unit_vec.y)
  2046. + (-prev_unit_vec.z * unit_vec.z) + (-prev_unit_vec.e * unit_vec.e);
  2047. // NOTE: Computed without any expensive trig, sin() or acos(), by trig half angle identity of cos(theta).
  2048. if (junction_cos_theta > 0.999999f) {
  2049. // For a 0 degree acute junction, just set minimum junction speed.
  2050. vmax_junction_sqr = sq(float(MINIMUM_PLANNER_SPEED));
  2051. }
  2052. else {
  2053. NOLESS(junction_cos_theta, -0.999999f); // Check for numerical round-off to avoid divide by zero.
  2054. // Convert delta vector to unit vector
  2055. xyze_float_t junction_unit_vec = unit_vec - prev_unit_vec;
  2056. normalize_junction_vector(junction_unit_vec);
  2057. const float junction_acceleration = limit_value_by_axis_maximum(block->acceleration, junction_unit_vec),
  2058. sin_theta_d2 = SQRT(0.5f * (1.0f - junction_cos_theta)); // Trig half angle identity. Always positive.
  2059. vmax_junction_sqr = junction_acceleration * junction_deviation_mm * sin_theta_d2 / (1.0f - sin_theta_d2);
  2060. #if ENABLED(JD_HANDLE_SMALL_SEGMENTS)
  2061. // For small moves with >135° junction (octagon) find speed for approximate arc
  2062. if (block->millimeters < 1 && junction_cos_theta < -0.7071067812f) {
  2063. #if ENABLED(JD_USE_MATH_ACOS)
  2064. #error "TODO: Inline maths with the MCU / FPU."
  2065. #elif ENABLED(JD_USE_LOOKUP_TABLE)
  2066. // Fast acos approximation (max. error +-0.01 rads)
  2067. // Based on LUT table and linear interpolation
  2068. /**
  2069. * // Generate the JD Lookup Table
  2070. * constexpr float c = 1.00751495f; // Correction factor to center error around 0
  2071. * for (int i = 0; i < jd_lut_count - 1; ++i) {
  2072. * const float x0 = (sq(i) - 1) / sq(i),
  2073. * y0 = acos(x0) * (i == 0 ? 1 : c),
  2074. * x1 = i < jd_lut_count - 1 ? 0.5 * x0 + 0.5 : 0.999999f,
  2075. * y1 = acos(x1) * (i < jd_lut_count - 1 ? c : 1);
  2076. * jd_lut_k[i] = (y0 - y1) / (x0 - x1);
  2077. * jd_lut_b[i] = (y1 * x0 - y0 * x1) / (x0 - x1);
  2078. * }
  2079. *
  2080. * // Compute correction factor (Set c to 1.0f first!)
  2081. * float min = INFINITY, max = -min;
  2082. * for (float t = 0; t <= 1; t += 0.0003f) {
  2083. * const float e = acos(t) / approx(t);
  2084. * if (isfinite(e)) {
  2085. * if (e < min) min = e;
  2086. * if (e > max) max = e;
  2087. * }
  2088. * }
  2089. * fprintf(stderr, "%.9gf, ", (min + max) / 2);
  2090. */
  2091. static constexpr int16_t jd_lut_count = 16;
  2092. static constexpr uint16_t jd_lut_tll = _BV(jd_lut_count - 1);
  2093. static constexpr int16_t jd_lut_tll0 = __builtin_clz(jd_lut_tll) + 1; // i.e., 16 - jd_lut_count + 1
  2094. static constexpr float jd_lut_k[jd_lut_count] PROGMEM = {
  2095. -1.03145837f, -1.30760646f, -1.75205851f, -2.41705704f,
  2096. -3.37769222f, -4.74888992f, -6.69649887f, -9.45661736f,
  2097. -13.3640480f, -18.8928222f, -26.7136841f, -37.7754593f,
  2098. -53.4201813f, -75.5458374f, -106.836761f, -218.532821f };
  2099. static constexpr float jd_lut_b[jd_lut_count] PROGMEM = {
  2100. 1.57079637f, 1.70887053f, 2.04220939f, 2.62408352f,
  2101. 3.52467871f, 4.85302639f, 6.77020454f, 9.50875854f,
  2102. 13.4009285f, 18.9188995f, 26.7321243f, 37.7885055f,
  2103. 53.4293975f, 75.5523529f, 106.841369f, 218.534011f };
  2104. const float neg = junction_cos_theta < 0 ? -1 : 1,
  2105. t = neg * junction_cos_theta;
  2106. const int16_t idx = (t < 0.00000003f) ? 0 : __builtin_clz(uint16_t((1.0f - t) * jd_lut_tll)) - jd_lut_tll0;
  2107. float junction_theta = t * pgm_read_float(&jd_lut_k[idx]) + pgm_read_float(&jd_lut_b[idx]);
  2108. if (neg > 0) junction_theta = RADIANS(180) - junction_theta; // acos(-t)
  2109. #else
  2110. // Fast acos(-t) approximation (max. error +-0.033rad = 1.89°)
  2111. // Based on MinMax polynomial published by W. Randolph Franklin, see
  2112. // https://wrf.ecse.rpi.edu/Research/Short_Notes/arcsin/onlyelem.html
  2113. // acos( t) = pi / 2 - asin(x)
  2114. // acos(-t) = pi - acos(t) ... pi / 2 + asin(x)
  2115. const float neg = junction_cos_theta < 0 ? -1 : 1,
  2116. t = neg * junction_cos_theta,
  2117. asinx = 0.032843707f
  2118. + t * (-1.451838349f
  2119. + t * ( 29.66153956f
  2120. + t * (-131.1123477f
  2121. + t * ( 262.8130562f
  2122. + t * (-242.7199627f
  2123. + t * ( 84.31466202f ) ))))),
  2124. junction_theta = RADIANS(90) + neg * asinx; // acos(-t)
  2125. // NOTE: junction_theta bottoms out at 0.033 which avoids divide by 0.
  2126. #endif
  2127. const float limit_sqr = (block->millimeters * junction_acceleration) / junction_theta;
  2128. NOMORE(vmax_junction_sqr, limit_sqr);
  2129. }
  2130. #endif // JD_HANDLE_SMALL_SEGMENTS
  2131. }
  2132. // Get the lowest speed
  2133. vmax_junction_sqr = _MIN(vmax_junction_sqr, block->nominal_speed_sqr, previous_nominal_speed_sqr);
  2134. }
  2135. else // Init entry speed to zero. Assume it starts from rest. Planner will correct this later.
  2136. vmax_junction_sqr = 0;
  2137. prev_unit_vec = unit_vec;
  2138. #endif
  2139. #ifdef USE_CACHED_SQRT
  2140. #define CACHED_SQRT(N, V) \
  2141. static float saved_V, N; \
  2142. if (V != saved_V) { N = SQRT(V); saved_V = V; }
  2143. #else
  2144. #define CACHED_SQRT(N, V) const float N = SQRT(V)
  2145. #endif
  2146. #if HAS_CLASSIC_JERK
  2147. /**
  2148. * Adapted from Průša MKS firmware
  2149. * https://github.com/prusa3d/Prusa-Firmware
  2150. */
  2151. CACHED_SQRT(nominal_speed, block->nominal_speed_sqr);
  2152. // Exit speed limited by a jerk to full halt of a previous last segment
  2153. static float previous_safe_speed;
  2154. // Start with a safe speed (from which the machine may halt to stop immediately).
  2155. float safe_speed = nominal_speed;
  2156. #ifndef TRAVEL_EXTRA_XYJERK
  2157. #define TRAVEL_EXTRA_XYJERK 0
  2158. #endif
  2159. const float extra_xyjerk = (de <= 0) ? TRAVEL_EXTRA_XYJERK : 0;
  2160. uint8_t limited = 0;
  2161. TERN(HAS_LINEAR_E_JERK, LOOP_XYZ, LOOP_XYZE)(i) {
  2162. const float jerk = ABS(current_speed[i]), // cs : Starting from zero, change in speed for this axis
  2163. maxj = (max_jerk[i] + (i == X_AXIS || i == Y_AXIS ? extra_xyjerk : 0.0f)); // mj : The max jerk setting for this axis
  2164. if (jerk > maxj) { // cs > mj : New current speed too fast?
  2165. if (limited) { // limited already?
  2166. const float mjerk = nominal_speed * maxj; // ns*mj
  2167. if (jerk * safe_speed > mjerk) safe_speed = mjerk / jerk; // ns*mj/cs
  2168. }
  2169. else {
  2170. safe_speed *= maxj / jerk; // Initial limit: ns*mj/cs
  2171. ++limited; // Initially limited
  2172. }
  2173. }
  2174. }
  2175. float vmax_junction;
  2176. if (moves_queued && !UNEAR_ZERO(previous_nominal_speed_sqr)) {
  2177. // Estimate a maximum velocity allowed at a joint of two successive segments.
  2178. // If this maximum velocity allowed is lower than the minimum of the entry / exit safe velocities,
  2179. // then the machine is not coasting anymore and the safe entry / exit velocities shall be used.
  2180. // Factor to multiply the previous / current nominal velocities to get componentwise limited velocities.
  2181. float v_factor = 1;
  2182. limited = 0;
  2183. // The junction velocity will be shared between successive segments. Limit the junction velocity to their minimum.
  2184. // Pick the smaller of the nominal speeds. Higher speed shall not be achieved at the junction during coasting.
  2185. CACHED_SQRT(previous_nominal_speed, previous_nominal_speed_sqr);
  2186. float smaller_speed_factor = 1.0f;
  2187. if (nominal_speed < previous_nominal_speed) {
  2188. vmax_junction = nominal_speed;
  2189. smaller_speed_factor = vmax_junction / previous_nominal_speed;
  2190. }
  2191. else
  2192. vmax_junction = previous_nominal_speed;
  2193. // Now limit the jerk in all axes.
  2194. TERN(HAS_LINEAR_E_JERK, LOOP_XYZ, LOOP_XYZE)(axis) {
  2195. // Limit an axis. We have to differentiate: coasting, reversal of an axis, full stop.
  2196. float v_exit = previous_speed[axis] * smaller_speed_factor,
  2197. v_entry = current_speed[axis];
  2198. if (limited) {
  2199. v_exit *= v_factor;
  2200. v_entry *= v_factor;
  2201. }
  2202. // Calculate jerk depending on whether the axis is coasting in the same direction or reversing.
  2203. const float jerk = (v_exit > v_entry)
  2204. ? // coasting axis reversal
  2205. ( (v_entry > 0 || v_exit < 0) ? (v_exit - v_entry) : _MAX(v_exit, -v_entry) )
  2206. : // v_exit <= v_entry coasting axis reversal
  2207. ( (v_entry < 0 || v_exit > 0) ? (v_entry - v_exit) : _MAX(-v_exit, v_entry) );
  2208. const float maxj = (max_jerk[axis] + (axis == X_AXIS || axis == Y_AXIS ? extra_xyjerk : 0.0f));
  2209. if (jerk > maxj) {
  2210. v_factor *= maxj / jerk;
  2211. ++limited;
  2212. }
  2213. }
  2214. if (limited) vmax_junction *= v_factor;
  2215. // Now the transition velocity is known, which maximizes the shared exit / entry velocity while
  2216. // respecting the jerk factors, it may be possible, that applying separate safe exit / entry velocities will achieve faster prints.
  2217. const float vmax_junction_threshold = vmax_junction * 0.99f;
  2218. if (previous_safe_speed > vmax_junction_threshold && safe_speed > vmax_junction_threshold)
  2219. vmax_junction = safe_speed;
  2220. }
  2221. else
  2222. vmax_junction = safe_speed;
  2223. previous_safe_speed = safe_speed;
  2224. #if HAS_JUNCTION_DEVIATION
  2225. NOMORE(vmax_junction_sqr, sq(vmax_junction)); // Throttle down to max speed
  2226. #else
  2227. vmax_junction_sqr = sq(vmax_junction); // Go up or down to the new speed
  2228. #endif
  2229. #endif // Classic Jerk Limiting
  2230. // Max entry speed of this block equals the max exit speed of the previous block.
  2231. block->max_entry_speed_sqr = vmax_junction_sqr;
  2232. // Initialize block entry speed. Compute based on deceleration to user-defined MINIMUM_PLANNER_SPEED.
  2233. const float v_allowable_sqr = max_allowable_speed_sqr(-block->acceleration, sq(float(MINIMUM_PLANNER_SPEED)), block->millimeters);
  2234. // If we are trying to add a split block, start with the
  2235. // max. allowed speed to avoid an interrupted first move.
  2236. block->entry_speed_sqr = !split_move ? sq(float(MINIMUM_PLANNER_SPEED)) : _MIN(vmax_junction_sqr, v_allowable_sqr);
  2237. // Initialize planner efficiency flags
  2238. // Set flag if block will always reach maximum junction speed regardless of entry/exit speeds.
  2239. // If a block can de/ac-celerate from nominal speed to zero within the length of the block, then
  2240. // the current block and next block junction speeds are guaranteed to always be at their maximum
  2241. // junction speeds in deceleration and acceleration, respectively. This is due to how the current
  2242. // block nominal speed limits both the current and next maximum junction speeds. Hence, in both
  2243. // the reverse and forward planners, the corresponding block junction speed will always be at the
  2244. // the maximum junction speed and may always be ignored for any speed reduction checks.
  2245. block->flag |= block->nominal_speed_sqr <= v_allowable_sqr ? BLOCK_FLAG_RECALCULATE | BLOCK_FLAG_NOMINAL_LENGTH : BLOCK_FLAG_RECALCULATE;
  2246. // Update previous path unit_vector and nominal speed
  2247. previous_speed = current_speed;
  2248. previous_nominal_speed_sqr = block->nominal_speed_sqr;
  2249. position = target; // Update the position
  2250. TERN_(HAS_POSITION_FLOAT, position_float = target_float);
  2251. TERN_(GRADIENT_MIX, mixer.gradient_control(target_float.z));
  2252. TERN_(POWER_LOSS_RECOVERY, block->sdpos = recovery.command_sdpos());
  2253. return true; // Movement was accepted
  2254. } // _populate_block()
  2255. /**
  2256. * Planner::buffer_sync_block
  2257. * Add a block to the buffer that just updates the position
  2258. */
  2259. void Planner::buffer_sync_block() {
  2260. // Wait for the next available block
  2261. uint8_t next_buffer_head;
  2262. block_t * const block = get_next_free_block(next_buffer_head);
  2263. // Clear block
  2264. memset(block, 0, sizeof(block_t));
  2265. block->flag = BLOCK_FLAG_SYNC_POSITION;
  2266. block->position = position;
  2267. // If this is the first added movement, reload the delay, otherwise, cancel it.
  2268. if (block_buffer_head == block_buffer_tail) {
  2269. // If it was the first queued block, restart the 1st block delivery delay, to
  2270. // give the planner an opportunity to queue more movements and plan them
  2271. // As there are no queued movements, the Stepper ISR will not touch this
  2272. // variable, so there is no risk setting this here (but it MUST be done
  2273. // before the following line!!)
  2274. delay_before_delivering = BLOCK_DELAY_FOR_1ST_MOVE;
  2275. }
  2276. block_buffer_head = next_buffer_head;
  2277. stepper.wake_up();
  2278. } // buffer_sync_block()
  2279. /**
  2280. * Planner::buffer_segment
  2281. *
  2282. * Add a new linear movement to the buffer in axis units.
  2283. *
  2284. * Leveling and kinematics should be applied ahead of calling this.
  2285. *
  2286. * a,b,c,e - target positions in mm and/or degrees
  2287. * fr_mm_s - (target) speed of the move
  2288. * extruder - target extruder
  2289. * millimeters - the length of the movement, if known
  2290. *
  2291. * Return 'false' if no segment was queued due to cleaning, cold extrusion, full queue, etc.
  2292. */
  2293. bool Planner::buffer_segment(const float &a, const float &b, const float &c, const float &e
  2294. #if HAS_DIST_MM_ARG
  2295. , const xyze_float_t &cart_dist_mm
  2296. #endif
  2297. , const feedRate_t &fr_mm_s, const uint8_t extruder, const float &millimeters/*=0.0*/
  2298. ) {
  2299. // If we are cleaning, do not accept queuing of movements
  2300. if (cleaning_buffer_counter) return false;
  2301. // When changing extruders recalculate steps corresponding to the E position
  2302. #if ENABLED(DISTINCT_E_FACTORS)
  2303. if (last_extruder != extruder && settings.axis_steps_per_mm[E_AXIS_N(extruder)] != settings.axis_steps_per_mm[E_AXIS_N(last_extruder)]) {
  2304. position.e = LROUND(position.e * settings.axis_steps_per_mm[E_AXIS_N(extruder)] * steps_to_mm[E_AXIS_N(last_extruder)]);
  2305. last_extruder = extruder;
  2306. }
  2307. #endif
  2308. // The target position of the tool in absolute steps
  2309. // Calculate target position in absolute steps
  2310. const abce_long_t target = {
  2311. int32_t(LROUND(a * settings.axis_steps_per_mm[A_AXIS])),
  2312. int32_t(LROUND(b * settings.axis_steps_per_mm[B_AXIS])),
  2313. int32_t(LROUND(c * settings.axis_steps_per_mm[C_AXIS])),
  2314. int32_t(LROUND(e * settings.axis_steps_per_mm[E_AXIS_N(extruder)]))
  2315. };
  2316. #if HAS_POSITION_FLOAT
  2317. const xyze_pos_t target_float = { a, b, c, e };
  2318. #endif
  2319. // DRYRUN prevents E moves from taking place
  2320. if (DEBUGGING(DRYRUN) || TERN0(CANCEL_OBJECTS, cancelable.skipping)) {
  2321. position.e = target.e;
  2322. TERN_(HAS_POSITION_FLOAT, position_float.e = e);
  2323. }
  2324. /* <-- add a slash to enable
  2325. SERIAL_ECHOPAIR(" buffer_segment FR:", fr_mm_s);
  2326. #if IS_KINEMATIC
  2327. SERIAL_ECHOPAIR(" A:", a);
  2328. SERIAL_ECHOPAIR(" (", position.a);
  2329. SERIAL_ECHOPAIR("->", target.a);
  2330. SERIAL_ECHOPAIR(") B:", b);
  2331. #else
  2332. SERIAL_ECHOPAIR_P(SP_X_LBL, a);
  2333. SERIAL_ECHOPAIR(" (", position.x);
  2334. SERIAL_ECHOPAIR("->", target.x);
  2335. SERIAL_CHAR(')');
  2336. SERIAL_ECHOPAIR_P(SP_Y_LBL, b);
  2337. #endif
  2338. SERIAL_ECHOPAIR(" (", position.y);
  2339. SERIAL_ECHOPAIR("->", target.y);
  2340. #if ENABLED(DELTA)
  2341. SERIAL_ECHOPAIR(") C:", c);
  2342. #else
  2343. SERIAL_CHAR(')');
  2344. SERIAL_ECHOPAIR_P(SP_Z_LBL, c);
  2345. #endif
  2346. SERIAL_ECHOPAIR(" (", position.z);
  2347. SERIAL_ECHOPAIR("->", target.z);
  2348. SERIAL_CHAR(')');
  2349. SERIAL_ECHOPAIR_P(SP_E_LBL, e);
  2350. SERIAL_ECHOPAIR(" (", position.e);
  2351. SERIAL_ECHOPAIR("->", target.e);
  2352. SERIAL_ECHOLNPGM(")");
  2353. //*/
  2354. // Queue the movement. Return 'false' if the move was not queued.
  2355. if (!_buffer_steps(target
  2356. #if HAS_POSITION_FLOAT
  2357. , target_float
  2358. #endif
  2359. #if HAS_DIST_MM_ARG
  2360. , cart_dist_mm
  2361. #endif
  2362. , fr_mm_s, extruder, millimeters)
  2363. ) return false;
  2364. stepper.wake_up();
  2365. return true;
  2366. } // buffer_segment()
  2367. /**
  2368. * Add a new linear movement to the buffer.
  2369. * The target is cartesian. It's translated to
  2370. * delta/scara if needed.
  2371. *
  2372. * rx,ry,rz,e - target position in mm or degrees
  2373. * fr_mm_s - (target) speed of the move (mm/s)
  2374. * extruder - target extruder
  2375. * millimeters - the length of the movement, if known
  2376. * inv_duration - the reciprocal if the duration of the movement, if known (kinematic only if feeedrate scaling is enabled)
  2377. */
  2378. bool Planner::buffer_line(const float &rx, const float &ry, const float &rz, const float &e, const feedRate_t &fr_mm_s, const uint8_t extruder, const float millimeters
  2379. #if ENABLED(SCARA_FEEDRATE_SCALING)
  2380. , const float &inv_duration
  2381. #endif
  2382. ) {
  2383. xyze_pos_t machine = { rx, ry, rz, e };
  2384. TERN_(HAS_POSITION_MODIFIERS, apply_modifiers(machine));
  2385. #if IS_KINEMATIC
  2386. #if HAS_JUNCTION_DEVIATION
  2387. const xyze_pos_t cart_dist_mm = {
  2388. rx - position_cart.x, ry - position_cart.y,
  2389. rz - position_cart.z, e - position_cart.e
  2390. };
  2391. #else
  2392. const xyz_pos_t cart_dist_mm = { rx - position_cart.x, ry - position_cart.y, rz - position_cart.z };
  2393. #endif
  2394. float mm = millimeters;
  2395. if (mm == 0.0)
  2396. mm = (cart_dist_mm.x != 0.0 || cart_dist_mm.y != 0.0) ? cart_dist_mm.magnitude() : ABS(cart_dist_mm.z);
  2397. // Cartesian XYZ to kinematic ABC, stored in global 'delta'
  2398. inverse_kinematics(machine);
  2399. #if ENABLED(SCARA_FEEDRATE_SCALING)
  2400. // For SCARA scale the feed rate from mm/s to degrees/s
  2401. // i.e., Complete the angular vector in the given time.
  2402. const float duration_recip = inv_duration ?: fr_mm_s / mm;
  2403. const xyz_pos_t diff = delta - position_float;
  2404. const feedRate_t feedrate = diff.magnitude() * duration_recip;
  2405. #else
  2406. const feedRate_t feedrate = fr_mm_s;
  2407. #endif
  2408. if (buffer_segment(delta.a, delta.b, delta.c, machine.e
  2409. #if HAS_JUNCTION_DEVIATION
  2410. , cart_dist_mm
  2411. #endif
  2412. , feedrate, extruder, mm
  2413. )) {
  2414. position_cart.set(rx, ry, rz, e);
  2415. return true;
  2416. }
  2417. else
  2418. return false;
  2419. #else
  2420. return buffer_segment(machine, fr_mm_s, extruder, millimeters);
  2421. #endif
  2422. } // buffer_line()
  2423. #if ENABLED(DIRECT_STEPPING)
  2424. void Planner::buffer_page(const page_idx_t page_idx, const uint8_t extruder, const uint16_t num_steps) {
  2425. if (!last_page_step_rate) {
  2426. kill(GET_TEXT(MSG_BAD_PAGE_SPEED));
  2427. return;
  2428. }
  2429. uint8_t next_buffer_head;
  2430. block_t * const block = get_next_free_block(next_buffer_head);
  2431. block->flag = BLOCK_FLAG_IS_PAGE;
  2432. #if FAN_COUNT > 0
  2433. FANS_LOOP(i) block->fan_speed[i] = thermalManager.fan_speed[i];
  2434. #endif
  2435. #if HAS_MULTI_EXTRUDER
  2436. block->extruder = extruder;
  2437. #endif
  2438. block->page_idx = page_idx;
  2439. block->step_event_count = num_steps;
  2440. block->initial_rate =
  2441. block->final_rate =
  2442. block->nominal_rate = last_page_step_rate; // steps/s
  2443. block->accelerate_until = 0;
  2444. block->decelerate_after = block->step_event_count;
  2445. // Will be set to last direction later if directional format.
  2446. block->direction_bits = 0;
  2447. #define PAGE_UPDATE_DIR(AXIS) \
  2448. if (!last_page_dir[_AXIS(AXIS)]) SBI(block->direction_bits, _AXIS(AXIS));
  2449. if (!DirectStepping::Config::DIRECTIONAL) {
  2450. PAGE_UPDATE_DIR(X);
  2451. PAGE_UPDATE_DIR(Y);
  2452. PAGE_UPDATE_DIR(Z);
  2453. PAGE_UPDATE_DIR(E);
  2454. }
  2455. // If this is the first added movement, reload the delay, otherwise, cancel it.
  2456. if (block_buffer_head == block_buffer_tail) {
  2457. // If it was the first queued block, restart the 1st block delivery delay, to
  2458. // give the planner an opportunity to queue more movements and plan them
  2459. // As there are no queued movements, the Stepper ISR will not touch this
  2460. // variable, so there is no risk setting this here (but it MUST be done
  2461. // before the following line!!)
  2462. delay_before_delivering = BLOCK_DELAY_FOR_1ST_MOVE;
  2463. }
  2464. // Move buffer head
  2465. block_buffer_head = next_buffer_head;
  2466. enable_all_steppers();
  2467. stepper.wake_up();
  2468. }
  2469. #endif // DIRECT_STEPPING
  2470. /**
  2471. * Directly set the planner ABC position (and stepper positions)
  2472. * converting mm (or angles for SCARA) into steps.
  2473. *
  2474. * The provided ABC position is in machine units.
  2475. */
  2476. void Planner::set_machine_position_mm(const float &a, const float &b, const float &c, const float &e) {
  2477. TERN_(DISTINCT_E_FACTORS, last_extruder = active_extruder);
  2478. TERN_(HAS_POSITION_FLOAT, position_float.set(a, b, c, e));
  2479. position.set(LROUND(a * settings.axis_steps_per_mm[A_AXIS]),
  2480. LROUND(b * settings.axis_steps_per_mm[B_AXIS]),
  2481. LROUND(c * settings.axis_steps_per_mm[C_AXIS]),
  2482. LROUND(e * settings.axis_steps_per_mm[E_AXIS_N(active_extruder)]));
  2483. if (has_blocks_queued()) {
  2484. //previous_nominal_speed_sqr = 0.0; // Reset planner junction speeds. Assume start from rest.
  2485. //previous_speed.reset();
  2486. buffer_sync_block();
  2487. }
  2488. else
  2489. stepper.set_position(position);
  2490. }
  2491. void Planner::set_position_mm(const float &rx, const float &ry, const float &rz, const float &e) {
  2492. xyze_pos_t machine = { rx, ry, rz, e };
  2493. #if HAS_POSITION_MODIFIERS
  2494. apply_modifiers(machine, true);
  2495. #endif
  2496. #if IS_KINEMATIC
  2497. position_cart.set(rx, ry, rz, e);
  2498. inverse_kinematics(machine);
  2499. set_machine_position_mm(delta.a, delta.b, delta.c, machine.e);
  2500. #else
  2501. set_machine_position_mm(machine);
  2502. #endif
  2503. }
  2504. /**
  2505. * Setters for planner position (also setting stepper position).
  2506. */
  2507. void Planner::set_e_position_mm(const float &e) {
  2508. const uint8_t axis_index = E_AXIS_N(active_extruder);
  2509. TERN_(DISTINCT_E_FACTORS, last_extruder = active_extruder);
  2510. const float e_new = e - TERN0(FWRETRACT, fwretract.current_retract[active_extruder]);
  2511. position.e = LROUND(settings.axis_steps_per_mm[axis_index] * e_new);
  2512. TERN_(HAS_POSITION_FLOAT, position_float.e = e_new);
  2513. TERN_(IS_KINEMATIC, position_cart.e = e);
  2514. if (has_blocks_queued())
  2515. buffer_sync_block();
  2516. else
  2517. stepper.set_axis_position(E_AXIS, position.e);
  2518. }
  2519. // Recalculate the steps/s^2 acceleration rates, based on the mm/s^2
  2520. void Planner::reset_acceleration_rates() {
  2521. #if ENABLED(DISTINCT_E_FACTORS)
  2522. #define AXIS_CONDITION (i < E_AXIS || i == E_AXIS_N(active_extruder))
  2523. #else
  2524. #define AXIS_CONDITION true
  2525. #endif
  2526. uint32_t highest_rate = 1;
  2527. LOOP_XYZE_N(i) {
  2528. max_acceleration_steps_per_s2[i] = settings.max_acceleration_mm_per_s2[i] * settings.axis_steps_per_mm[i];
  2529. if (AXIS_CONDITION) NOLESS(highest_rate, max_acceleration_steps_per_s2[i]);
  2530. }
  2531. cutoff_long = 4294967295UL / highest_rate; // 0xFFFFFFFFUL
  2532. TERN_(HAS_LINEAR_E_JERK, recalculate_max_e_jerk());
  2533. }
  2534. // Recalculate position, steps_to_mm if settings.axis_steps_per_mm changes!
  2535. void Planner::refresh_positioning() {
  2536. LOOP_XYZE_N(i) steps_to_mm[i] = 1.0f / settings.axis_steps_per_mm[i];
  2537. set_position_mm(current_position);
  2538. reset_acceleration_rates();
  2539. }
  2540. inline void limit_and_warn(float &val, const uint8_t axis, PGM_P const setting_name, const xyze_float_t &max_limit) {
  2541. const uint8_t lim_axis = axis > E_AXIS ? E_AXIS : axis;
  2542. const float before = val;
  2543. LIMIT(val, 0.1, max_limit[lim_axis]);
  2544. if (before != val) {
  2545. SERIAL_CHAR(axis_codes[lim_axis]);
  2546. SERIAL_ECHOPGM(" Max ");
  2547. serialprintPGM(setting_name);
  2548. SERIAL_ECHOLNPAIR(" limited to ", val);
  2549. }
  2550. }
  2551. void Planner::set_max_acceleration(const uint8_t axis, float targetValue) {
  2552. #if ENABLED(LIMITED_MAX_ACCEL_EDITING)
  2553. #ifdef MAX_ACCEL_EDIT_VALUES
  2554. constexpr xyze_float_t max_accel_edit = MAX_ACCEL_EDIT_VALUES;
  2555. const xyze_float_t &max_acc_edit_scaled = max_accel_edit;
  2556. #else
  2557. constexpr xyze_float_t max_accel_edit = DEFAULT_MAX_ACCELERATION;
  2558. const xyze_float_t max_acc_edit_scaled = max_accel_edit * 2;
  2559. #endif
  2560. limit_and_warn(targetValue, axis, PSTR("Acceleration"), max_acc_edit_scaled);
  2561. #endif
  2562. settings.max_acceleration_mm_per_s2[axis] = targetValue;
  2563. // Update steps per s2 to agree with the units per s2 (since they are used in the planner)
  2564. reset_acceleration_rates();
  2565. }
  2566. void Planner::set_max_feedrate(const uint8_t axis, float targetValue) {
  2567. #if ENABLED(LIMITED_MAX_FR_EDITING)
  2568. #ifdef MAX_FEEDRATE_EDIT_VALUES
  2569. constexpr xyze_float_t max_fr_edit = MAX_FEEDRATE_EDIT_VALUES;
  2570. const xyze_float_t &max_fr_edit_scaled = max_fr_edit;
  2571. #else
  2572. constexpr xyze_float_t max_fr_edit = DEFAULT_MAX_FEEDRATE;
  2573. const xyze_float_t max_fr_edit_scaled = max_fr_edit * 2;
  2574. #endif
  2575. limit_and_warn(targetValue, axis, PSTR("Feedrate"), max_fr_edit_scaled);
  2576. #endif
  2577. settings.max_feedrate_mm_s[axis] = targetValue;
  2578. }
  2579. void Planner::set_max_jerk(const AxisEnum axis, float targetValue) {
  2580. #if HAS_CLASSIC_JERK
  2581. #if ENABLED(LIMITED_JERK_EDITING)
  2582. constexpr xyze_float_t max_jerk_edit =
  2583. #ifdef MAX_JERK_EDIT_VALUES
  2584. MAX_JERK_EDIT_VALUES
  2585. #else
  2586. { (DEFAULT_XJERK) * 2, (DEFAULT_YJERK) * 2,
  2587. (DEFAULT_ZJERK) * 2, (DEFAULT_EJERK) * 2 }
  2588. #endif
  2589. ;
  2590. limit_and_warn(targetValue, axis, PSTR("Jerk"), max_jerk_edit);
  2591. #endif
  2592. max_jerk[axis] = targetValue;
  2593. #else
  2594. UNUSED(axis); UNUSED(targetValue);
  2595. #endif
  2596. }
  2597. #if HAS_WIRED_LCD
  2598. uint16_t Planner::block_buffer_runtime() {
  2599. #ifdef __AVR__
  2600. // Protect the access to the variable. Only required for AVR, as
  2601. // any 32bit CPU offers atomic access to 32bit variables
  2602. const bool was_enabled = stepper.suspend();
  2603. #endif
  2604. uint32_t bbru = block_buffer_runtime_us;
  2605. #ifdef __AVR__
  2606. // Reenable Stepper ISR
  2607. if (was_enabled) stepper.wake_up();
  2608. #endif
  2609. // To translate µs to ms a division by 1000 would be required.
  2610. // We introduce 2.4% error here by dividing by 1024.
  2611. // Doesn't matter because block_buffer_runtime_us is already too small an estimation.
  2612. bbru >>= 10;
  2613. // limit to about a minute.
  2614. NOMORE(bbru, 0x0000FFFFUL);
  2615. return bbru;
  2616. }
  2617. void Planner::clear_block_buffer_runtime() {
  2618. #ifdef __AVR__
  2619. // Protect the access to the variable. Only required for AVR, as
  2620. // any 32bit CPU offers atomic access to 32bit variables
  2621. const bool was_enabled = stepper.suspend();
  2622. #endif
  2623. block_buffer_runtime_us = 0;
  2624. #ifdef __AVR__
  2625. // Reenable Stepper ISR
  2626. if (was_enabled) stepper.wake_up();
  2627. #endif
  2628. }
  2629. #endif
  2630. #if ENABLED(AUTOTEMP)
  2631. void Planner::autotemp_update() {
  2632. #if ENABLED(AUTOTEMP_PROPORTIONAL)
  2633. const int16_t target = thermalManager.degTargetHotend(active_extruder);
  2634. autotemp_min = target + AUTOTEMP_MIN_P;
  2635. autotemp_max = target + AUTOTEMP_MAX_P;
  2636. #endif
  2637. autotemp_factor = TERN(AUTOTEMP_PROPORTIONAL, AUTOTEMP_FACTOR_P, 0);
  2638. autotemp_enabled = autotemp_factor != 0;
  2639. }
  2640. void Planner::autotemp_M104_M109() {
  2641. #if ENABLED(AUTOTEMP_PROPORTIONAL)
  2642. const int16_t target = thermalManager.degTargetHotend(active_extruder);
  2643. autotemp_min = target + AUTOTEMP_MIN_P;
  2644. autotemp_max = target + AUTOTEMP_MAX_P;
  2645. #endif
  2646. if (parser.seenval('S')) autotemp_min = parser.value_celsius();
  2647. if (parser.seenval('B')) autotemp_max = parser.value_celsius();
  2648. // When AUTOTEMP_PROPORTIONAL is enabled, F0 disables autotemp.
  2649. // Normally, leaving off F also disables autotemp.
  2650. autotemp_factor = parser.seen('F') ? parser.value_float() : TERN(AUTOTEMP_PROPORTIONAL, AUTOTEMP_FACTOR_P, 0);
  2651. autotemp_enabled = autotemp_factor != 0;
  2652. }
  2653. #endif